पायथन में फ़ंक्शन डॉक्यूमेंटेशन प्रदर्शित करना

फ़ंक्शन के बॉडी में, किए जाने वाले कार्य के सार का वर्णन करने वाली एक स्ट्रिंग लिखी जा सकती है। ऐसी स्ट्रिंग को आमतौर पर फ़ंक्शन का डॉक्यूमेंटेशन माना जाता है। यह सिंगल कोट्स में enclosed होती है और फ़ंक्शन के बॉडी की पहली लाइन में रखी जाती है। इसे पढ़ने के लिए, एक विशेष फ़ंक्शन help का उपयोग करना होगा, जिसके पैरामीटर में फ़ंक्शन का नाम पास किया जाता है।

मान लीजिए कि हमारे पास दो नंबरों को जोड़ने वाला एक फ़ंक्शन है। इसके बारे में संबंधित जानकारी के साथ एक स्ट्रिंग छोड़ी गई है:

pythondef getSum(num1, num2):
  'यह फ़ंक्शन दो नंबरों को जोड़ता है'
  return num1 + num2

आइए help को कॉल करें और जानें कि getSum में क्या कमेंट किया गया है:

pythonhelp(getSum)

कोड निष्पादित होने के बाद, कंसोल में फ़ंक्शन के नाम और उसके डॉक्यूमेंटेशन के साथ एक लाइन दिखाई देगी:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  यह फ़ंक्शन दो नंबरों को जोड़ता है

help फ़ंक्शन का उपयोग करके मानक फ़ंक्शंस का डॉक्यूमेंटेशन भी पढ़ा जा सकता है। आइए print फ़ंक्शन के बारे में जानकारी प्राप्त करें:

pythonhelp(print)

फ़ंक्शन से केवल डॉक्यूमेंटेशन स्ट्रिंग प्रदर्शित करने के लिए, help में फ़ंक्शन नाम के बाद सर्विस कंस्ट्रक्शन .__doc__ पास करनी होगी:

pythonhelp(print.__doc__)