टिप्पणियाँ और कोड की पठनीयता

टिप्पणियों का उपयोग कोड समझाने और उसे अधिक पठनीय बनाने के लिए किया जाता है। Python का इंटरप्रेटर इन्हें अनदेखा करता है और इनका प्रोग्राम के निष्पादन पर कोई प्रभाव नहीं पड़ता।

इस पाठ में आप टिप्पणियों का उपयोग करना और साफ़, पठनीय कोड लिखना सीखेंगे।

एक-पंक्ति टिप्पणियाँ # से शुरू होती हैं। उस पंक्ति में # के बाद आने वाली हर चीज़ को Python अनदेखा कर देता है। उदाहरण के लिए:

# This is a single-line comment
print("Hello, World!")

बहु-पंक्ति टिप्पणियाँ तिहरे उद्धरण चिह्नों (''' या """) का उपयोग करके लिखी जा सकती हैं। उदाहरण के लिए:

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

टिप्पणियाँ इन कार्यों में सहायक होती हैं:

• जटिल कोड समझाने में।
• दूसरों और भविष्य में स्वयं आपके लिए कोड समझना आसान बनाने में।
• त्रुटि-खोज और समस्या-निवारण में।

याद रखें, टिप्पणियाँ मनुष्यों के लिए होती हैं, मशीन के लिए नहीं!

अच्छी टिप्पणियाँ लिखने के लिए कुछ सुझाव ये हैं:

• टिप्पणियों को संक्षिप्त और सार्थक रखें।
• x = x + 1 के लिए # Increment x by 1 जैसी स्पष्ट टिप्पणियों से बचें।
• कोड को किसी विशेष तरीके से लिखने का कारण समझाने के लिए टिप्पणियों का उपयोग करें।

पठनीय कोड का रखरखाव और उसमें त्रुटि-खोज करना आसान होता है। कुछ सुझाव ये हैं:

• सार्थक चर और फ़ंक्शन नामों का उपयोग करें।
• कोड की पंक्तियों को छोटा रखें।
• टिप्पणियों का उपयोग करके कोड को खंडों में व्यवस्थित करें।

आप त्रुटि-खोज के लिए कोड को अस्थायी रूप से निष्क्रिय करने हेतु टिप्पणियों का उपयोग कर सकते हैं। उदाहरण के लिए:

# print("This line is commented out and won’t run.")
print("This line will run.")

आप फ़ंक्शनों का दस्तावेज़ीकरण करने और उनके उद्देश्य को समझाने के लिए टिप्पणियों का उपयोग कर सकते हैं:

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

इस पाठ में आपने सीखा:

• Python में एक-पंक्ति और बहु-पंक्ति टिप्पणियाँ कैसे लिखें।
• कोड की पठनीयता और रखरखाव के लिए टिप्पणियों का महत्व।
• टिप्पणियाँ लिखने और कोड की पठनीयता सुधारने की सर्वोत्तम विधियाँ।

बहुत बढ़िया! अब अगले विषय पर चलते हैं।