अजगर टिप्पणियाँ (उदाहरण के साथ)

इस ट्यूटोरियल में, हम उदाहरणों की मदद से पायथन में टिप्पणियां बनाना सीखेंगे।

वीडियो: पायथन में टिप्पणियाँ

टिप्पणियां ऐसे विवरण हैं जो प्रोग्रामर को प्रोग्राम के इरादे और कार्यक्षमता को बेहतर ढंग से समझने में मदद करते हैं।

वे पायथन दुभाषिया द्वारा पूरी तरह से नजरअंदाज कर दिए जाते हैं।

टिप्पणियों का उपयोग करने के लाभ

कार्यक्रमों में टिप्पणियों का उपयोग करना हमारे कोड को अधिक समझने योग्य बनाता है। यह प्रोग्राम को अधिक पठनीय बनाता है जो हमें याद रखने में मदद करता है कि कोड के कुछ ब्लॉक क्यों लिखे गए थे।

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

पायथन में सिंगल-लाइन टिप्पणियाँ

पायथन में, हम #सिंगल-लाइन टिप्पणी लिखने के लिए हैश प्रतीक का उपयोग करते हैं ।

उदाहरण 1: एकल-पंक्ति टिप्पणियाँ लिखना

 # printing a string print('Hello world') 

आउटपुट

 नमस्ते दुनिया 

यहाँ, टिप्पणी है:

 # printing a string 

इस पंक्ति को पायथन दुभाषिया द्वारा अनदेखा किया जाता है।

उसके बाद आने वाली हर चीज #को नजरअंदाज कर दिया जाता है। तो, हम उपरोक्त कार्यक्रम को एक पंक्ति में भी लिख सकते हैं:

 print('Hello world') #printing a string 

इस कार्यक्रम का आउटपुट उदाहरण 1 के समान होगा । दुभाषिया सभी पाठ की उपेक्षा करता है #।

पायथन में मल्टी-लाइन टिप्पणियाँ

पायथन बहुस्तरीय टिप्पणियों को लिखने के लिए एक अलग तरह की पेशकश नहीं करता है। हालाँकि, इस समस्या को हल करने के लिए अन्य तरीके हैं।

हम #कई लाइनों पर टिप्पणी की प्रत्येक पंक्ति की शुरुआत में उपयोग कर सकते हैं ।

उदाहरण 2: एकाधिक # का उपयोग करना

 # it is a # multiline # comment 

यहां, प्रत्येक पंक्ति को एक टिप्पणी के रूप में माना जाता है और उन सभी को अनदेखा किया जाता है।

मल्टी-लाइन टिप्पणियों के लिए स्ट्रिंग साहित्य

भले ही पायथन में बहुस्तरीय टिप्पणियां लिखने का कोई अनूठा तरीका नहीं है, हम जानते हैं कि पायथन दुभाषिया स्ट्रिंग शाब्दिकों को अनदेखा करता है जो एक चर के लिए असाइन नहीं किए जाते हैं।

इसलिए, हम एक एकल-पंक्ति टिप्पणी भी लिख सकते हैं:

 #this is a comment 'this is an unassigned string as a comment ' 

यहां, हम देख सकते हैं कि कार्यक्रम की दूसरी पंक्ति एक स्ट्रिंग है लेकिन किसी भी चर या फ़ंक्शन को नहीं दी गई है। तो, दुभाषिया स्ट्रिंग की उपेक्षा करता है।

इसी तरह से, हम बहुस्तरीय टिप्पणियों को लिखने के लिए मल्टीलाइन स्ट्रिंग्स (ट्रिपल उद्धरण) का उपयोग कर सकते हैं।

उद्धरण चरित्र या तो किया जा सकता है 'या "।

उदाहरण 3: बहु-पंक्ति टिप्पणियाँ लिखने के लिए स्ट्रिंग साहित्य का उपयोग करना

 ''' I am a multiline comment! ''' print("Hello World") 

यहां, मल्टीलाइन स्ट्रिंग को किसी भी वेरिएबल को नहीं सौंपा गया है, इसलिए इसे दुभाषिया द्वारा अनदेखा किया जाता है। भले ही यह तकनीकी रूप से एक बहुभाषी टिप्पणी नहीं है, लेकिन इसे एक के रूप में इस्तेमाल किया जा सकता है।

पायथन डॉकस्ट्रिंग्स

कन्वेंशन द्वारा, ट्रिपल कोट जो फ़ंक्शन, विधि या वर्ग परिभाषा के ठीक बाद दिखाई देते हैं, डॉकस्ट्रिंग्स (प्रलेखन स्ट्रिंग) हैं।
Docstrings ऑब्जेक्ट्स के साथ जुड़े होते हैं और उन्हें __doc__विशेषता का उपयोग करके एक्सेस किया जा सकता है ।

अधिक जानने के लिए, पायथन डोकस्ट्रिंग्स पर जाएँ।

बेहतर टिप्पणियाँ कैसे लिखें?

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