कोड टिप्पणी

इससे कोई फर्क नहीं पड़ता कि हम किस भाषा में प्रोग्राम लिखते हैं, यह टिप्पणी करने की आवश्यकता है।
बहुत बार, टिप्पणियां अपने कार्य को पूरा नहीं करती हैं, लेकिन बस मात्रा बनाते हैं और जो कुछ भी लिखा जाता है, उसे बिना संकेतों के विघटित करना पड़ता है, कभी-कभी अतिरिक्त प्रोग्राम फ़ाइलों का जिक्र होता है, जो विकास की गति को प्रभावित करता है।

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

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

मैंने आपको कुछ युक्तियों की याद दिलाने का फैसला किया, जिन्हें आपको कोड पर टिप्पणी लिखते समय पालन करने की आवश्यकता है।

कुछ टिप्स

0. प्रत्येक प्रोग्रामर का प्राथमिकता कार्य प्रासंगिक टिप्पणियां हैं।
9. "कोड लिखें जैसे कि यह एक हिंसक मनोरोगी के साथ होगा जो जानता है कि आप कहां रहते हैं" - मैककोनेल, स्टीव ।
2. हम कोड पर सिर्फ अपने लिए टिप्पणी करते हैं (सक्षम रूप से, ताकि दूसरों को समझ में आए)।
3. स्पष्ट चीजों पर टिप्पणी करने की आवश्यकता नहीं है।
4. टिप्पणी को कोड को पूरक करना चाहिए, न कि उसे फिर से लिखना चाहिए।
5. यदि कोड भाषा के मूल में वर्णित मानक कार्यों, निर्माणों या वर्गों का उपयोग करता है, तो अपना समय बर्बाद न करें, इस मामले में केवल सही ढंग से स्वरूपित कोड मदद करेगा।
6. कोड के टुकड़े पर टिप्पणी, टिप्पणी कोड के समान इंडेंटेशन के साथ लिखना आवश्यक है।
7. किसी के साथ कमेंट में बात करना बहुतों की बुरी आदत होती है, कमेंट छोटा और स्पष्ट होना चाहिए।
8. कमेंट्री में, आप बाद में कार्य छोड़ सकते हैं, जो किसी कारण से पूरा नहीं हुआ है। मैं इस तरह के नोटों को एक अलग फ़ाइल में संग्रहीत करने की अनुशंसा नहीं करता हूं, क्योंकि आपके अलावा, कोई और व्यक्ति कोड पर काम कर सकता है यदि यह देखने के लिए जगह है कि क्या और कहाँ पूरा नहीं हुआ है, लेकिन इसे लागू किया जाएगा। शायद अधिक प्रासंगिक समाधान मिलेंगे।
9. अच्छा अभ्यास - फाइल की शुरुआत में, इसके उद्देश्य का संक्षेप में वर्णन करें।
10. नई कक्षाएं और कार्य - यह वर्णन करना उचित है कि आने वाले डेटा को क्या और कहाँ से मिलता है और किस उद्देश्य से है।
11. अनावश्यक कोड टिप्पणियों से छुटकारा पाने के लिए, आप कक्षाओं, कार्यों, वस्तुओं आदि का नाम चुन सकते हैं। नियुक्ति के द्वारा।

निष्कर्ष

परिणामस्वरूप, हम और हमारे सहकर्मी अतिरिक्त समय टिप्पणी करने में खर्च नहीं करेंगे। हम उन लोगों को नाराज नहीं करेंगे जो कोड को अलग करने के लिए ले जाएंगे, और यहां तक ​​कि उन्हें किसी बिंदु पर प्रसन्न भी करेंगे।

इसके अलावा, स्वैच्छिक टिप्पणियों के प्रशंसकों के लिए, मैं उन्हें अलग प्रलेखन के साथ प्रतिस्थापित करने की सलाह दे सकता हूं।

अपना समय बचाएं और जो आपके कोड पर काम करेंगे, उन्हें छोड़ दें।

पीएस मैं प्रोग्रामर की पिछली छुट्टी पर सभी को बधाई देता हूं, मैं चाहता हूं कि आपके हित और आपका काम एक हो। ताकि ग्राहक उत्कृष्ट हों और शुरू किया गया कोई भी व्यवसाय सफलता के लिए लाया जाए।