क्यों [नहीं] कोड पर टिप्पणी करने की आवश्यकता है

हाल ही में, यह विचार कि कोड में टिप्पणी अनिवार्य नहीं है, या हानिकारक भी है, लोकप्रियता प्राप्त कर रहा है। अभी कल रात, एक युवा प्रोग्रामर के एक दोस्त से बात कर रही थी, जिसने मुझे उसका कोड देखने के लिए कहा, मैंने पाया कि इसमें कोई टिप्पणी नहीं थी, यहाँ तक कि विधियों के सामान्य विवरण भी नहीं थे। मेरे आश्चर्यचकित करने वाले इमोटिकॉन के लिए, एक उत्तर था: " टिप्पणियाँ बुरे कोड का पहला संकेत हैं ।" और उसके साथ नरक करने के लिए, एक नौसिखिया प्रोग्रामर के साथ, लेकिन मैं समय-समय पर ब्लॉगों पर कुछ इसी तरह पढ़ता हूं और सहकर्मियों से सुनता हूं। हो सकता है कि प्रोग्रामिंग ने एक बार फिर एक कदम आगे बढ़ाया हो, और मैं लैगार्ड के बीच में हूं? कटौती के तहत, इस बारे में थोड़ा सोचा गया कि कब और क्यों यह आपके कोड पर टिप्पणी करने के लायक है या नहीं।

तो, कोड में टिप्पणियों के खिलाफ दो मुख्य कथन हैं:

कथन १: "कोड का अपना सबसे अच्छा दस्तावेज है।"

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

दुर्भाग्य से, वास्तविक जीवन में, एक सुंदर और तार्किक कोड का उत्पादन करना हमेशा संभव नहीं होता है। कभी-कभी गुणवत्ता परवरिश के लिए पर्याप्त समय नहीं होता है, और जैसा आप लिख सकते हैं वैसा ही लिखें। कभी-कभी व्यापारिक तर्क स्वयं इतना भ्रमित होता है कि 100 ग्राम के बिना इसे महसूस नहीं किया जा सकता है। और जब आप इसे महसूस करते हैं, तो आप इस कार्य के बारे में भूलना चाहते हैं और, बस मामले में, लगभग पांच बार स्नान करें। और कभी-कभी, जो आपको सुंदर और तार्किक लगता है, वह आपके सहकर्मियों के लिए कठिनाइयों का कारण बन सकता है।

तो कोड ही सबसे अच्छा दस्तावेज हो सकता है? बेशक, यह सुनिश्चित हो सकता है, लेकिन टिप्पणी की एक अतिरिक्त पंक्ति सम्मिलित करने से डरो मत, या कम से कम उपयोग किए गए पैटर्न का संदर्भ दें। शायद भविष्य में, यह किसी को थोड़ा समय बचाएगा।

कथन २: "टिप्पणियाँ पुरानी हो सकती हैं।"

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

क्यों?

मुझे गलत मत समझिए, मैं हर लाइन पर टिप्पणी करने का अभियान नहीं चला रहा हूं। इसके अलावा, मैं स्वयं की शैली में टिप्पणियों पर विचार करता हूं:

$i++; //  

. ! !

“?”, “?”. , . , , “ ? !”, , , . . , , . — .

.

, . : “, , ”. - , — , , . , , , , .