हाल ही में मैं कोड आधार के उन हिस्सों को फिर से बनाने पर काम कर रहा हूं जो मैं वर्तमान में काम कर रहा हूं - न केवल इसे खुद को बेहतर समझने के लिए, बल्कि उन लोगों के लिए भी इसे आसान बनाने के लिए जो कोड पर काम कर रहे हैं।
मैं यह सोचने के पक्ष में झुक जाता हूं कि स्व-दस्तावेजीकरण कोड अच्छा है । मुझे लगता है कि यह क्लीनर है और अगर कोड खुद के लिए बोलता है, तो ठीक है ... यह बहुत अच्छा है ।
दूसरी ओर हमारे पास javadocs जैसे दस्तावेज हैं। मुझे यह पसंद है, लेकिन एक निश्चित जोखिम है कि यहां टिप्पणियां पुरानी हो गई हैं (साथ ही सामान्य रूप से टिप्पणियां भी)। हालांकि, अगर वे अप-टू-डेट हैं, तो वे एक जटिल एल्गोरिथ्म को समझने के साथ बेहद उपयोगी हो सकते हैं।
इसके लिए सबसे अच्छे अभ्यास क्या हैं? आप स्व-दस्तावेजीकरण कोड और javadocs के बीच की रेखा कहाँ खींचते हैं?