मैं कुछ समय से इस विषय पर सोच रहा था।
मेरा निष्कर्ष है - यह मात्रा की बात नहीं है, बल्कि गुणवत्ता और संदर्भ की है।
उदाहरण के लिए, एक उचित प्रोजेक्ट संरचना यह बताते हुए टिप्पणी करती है कि फाइलें कहां स्थित हैं (कार्यान्वयन बनाम गहनता)
इसी तरह, संदर्भ को स्पष्ट करने के लिए वर्गीकरण नामकरण (एक रोगी पर आईडी -> रोगी। डी)।
मेरा मानना है कि डीडीडी का अच्छा प्रलेखन में एक कहना है - वर्गीकरण संदर्भ प्रदान करता है, संदर्भ सीमाएं बनाता है और सीमाएं जानबूझकर कार्यान्वयन को जन्म देती हैं (यह वह जगह है जहां यह मौजूद है, बजाय इसके अस्तित्व की आवश्यकता है)।
कोड अपने आप में पर्याप्त नहीं माना जाता है कि उसे दस्तावेज माना जाए। अधिकांश मामलों में समस्या इस तथ्य में नहीं रहती है कि कोड के काम करने की टिप्पणी की गई है या टिप्पणी नहीं की गई है, बल्कि ड्राइविंग बल (डोमेन लॉजिक) नहीं है।
हम कभी-कभी यह भूल जाते हैं कि बॉस कौन है - यदि कोड बदलता है, तो डोमेन तर्क या तर्क नहीं होना चाहिए, लेकिन यदि डोमेन तर्क या तर्क परिवर्तन कोड निश्चित रूप से होगा।
संगति बहुत महत्वपूर्ण है - यदि यह सुसंगत नहीं है तो स्वयं द्वारा सम्मेलन बेकार है।
डिजाइन पैटर्न सिर्फ 'अच्छा अभ्यास' नहीं हैं - यह हमें डेवलपर्स को समझना चाहिए कि लिंगो है। एक कारखाने में एक नए प्रकार को जोड़ने के लिए एक डेवलपर को बताना एक नए प्रकार को एक विधि में जोड़ना बेहतर है (जहां संदर्भ और संगतता कमजोर या गायब है)।
आधा संघर्ष परिचित है ।
एक तरफ ध्यान दें, तो एपीआई जो बहुत सारे प्रलेखन का पक्ष लेते हैं, वे बहुत ही डोमेन और संदर्भ संवेदनशील हैं। कभी-कभी डुप्लिकेटिंग कार्यक्षमता बुराई नहीं है (एक ही बात, विभिन्न संदर्भों) और इसे अलग-अलग माना जाना चाहिए।
टिप्पणी करने के संदर्भ में, तर्क के पीछे डोमेन तर्क को इंगित करना हमेशा अच्छा होता है।
उदाहरण के लिए, आप चिकित्सा उद्योग में काम कर रहे हैं। अपनी विधि में आप "IsPatientSecure = true;" लिखते हैं।
अब, कोई भी सभ्य प्रोग्रामर यह पता लगा सकता है कि मरीज को सुरक्षित बताया जा रहा है। लेकिन क्यों? निहितार्थ क्या हैं?
इस मामले में रोगी एक कैदी है जिसे सुरक्षित रूप से एक ऑफ परिसर अस्पताल में स्थानांतरित किया गया था। यह जानने के बाद, उन घटनाओं की कल्पना करना आसान है जो इस बिंदु तक ले जाते हैं (और शायद अभी भी क्या होने की जरूरत है)।
हो सकता है कि यह पोस्ट दार्शनिक लगे - लेकिन याद रखें कि यह 'तर्क' या 'तर्क' है जिसके बारे में आप लिख रहे हैं - कोड नहीं।