क्या उदीयमान डेवलपर्स के उद्देश्य से कोड टिप्पणी लिखने के लिए एक निश्चित मार्गदर्शिका है?
आदर्श रूप से, यह तब कवर होगा जब टिप्पणियों का उपयोग किया जाना चाहिए (और नहीं होना चाहिए) और क्या टिप्पणियों में होना चाहिए।
यह उत्तर :
आप क्या कर रहे हैं, इस पर टिप्पणी न करें, लेकिन आप ऐसा क्यों कर रहे हैं।
WHAT का समर्थन करने के लिए चर नामों के उचित विकल्प के साथ स्वच्छ, पठनीय और सरल कोड द्वारा देखभाल की जाती है। टिप्पणियाँ कोड को एक उच्च स्तर की संरचना दिखाती हैं जो कोड द्वारा ही नहीं (या कठिन है) शो कर सकती हैं।
करीब आता है, लेकिन अनुभवहीन प्रोग्रामर के लिए यह थोड़ा संक्षिप्त है (कई उदाहरणों और कोने के मामलों के साथ एक विस्तार उत्कृष्ट होगा, मुझे लगता है)।
अद्यतन : यहाँ उत्तर के अलावा, मुझे लगता है कि यह एक और प्रश्न का उत्तर अत्यधिक प्रासंगिक है।
मुझे लगता है कि हम जल्दी से एक ऐसी दुनिया में जा रहे हैं जहाँ लोग किसी भी तरह की टिप्पणी नहीं करते हैं। बेहतर (अधिक संभावना) बदतर के लिए। चुस्त।
—
एमके ०१
@ एमके: यदि ऐसा है (मैं इस जवाब से अधिक सहमत हूं ), तो एक गाइड बता रहा है कि टिप्पणी कैसे नहीं लिखनी चाहिए, और उन्हें क्यों टाला जाना चाहिए, यह उतना ही उपयोगी होगा। तथ्य की बात के रूप में, अधिक अलग दृष्टिकोण, बेहतर।
—
कैमरून
मुझे लगता है कि कोड पढ़ने की गति में सुधार करने के लिए छोटी टिप्पणियाँ बहुत उपयोगी हैं और हमेशा रहेंगी। मैं पूरी तरह से "बासी टिप्पणी" तर्क नहीं खरीदता, भले ही वे बासी हों, उनका ऐतिहासिक मूल्य होगा। मैं एक कोड बेस पर काम करता था, जिसमें कभी-कभार यहाँ और वहाँ विस्तृत टिप्पणियाँ होती थीं और कभी भी मुझे उस टिप्पणी से काट दिया जाता था जो तारीख की समस्या से बाहर थी।
—
15:01 बजे एमके 01
यह भी देखें: "टिप्पणियाँ एक कोड गंध हैं"
—
gnat