एक समारोह

Question

से docstring हो रही है मैं निम्नलिखित समारोह:

def my_func(): 
    """My docstring is both funny and informative""" 
    pass 

मैं कैसे docstring के लिए उपयोग मिलता है?

Answer 1

सहभागितापूर्ण तरीके से, आप इसे

help(my_func) 

साथ प्रदर्शित कर सकते हैं या कोड से आप के साथ

my_func.__doc__ 

Answer 2

तुम भी inspect.getdoc उपयोग कर सकते हैं इसे पुनः प्राप्त कर सकते हैं। यह रिक्त स्थान पर टैब को सामान्यीकृत करके __doc__ को साफ़ करता है और सामान्य प्रमुख रिक्त स्थान को निकालने के लिए डॉक्टर निकाय को स्थानांतरित करता है।

Answer 3

IPython या jupyter नोटबुक पर, आप ऊपर वर्णित सभी तरीकों का उपयोग कर सकते हैं, लेकिन मैं दोनों विधि हस्ताक्षर और docstring का त्वरित सारांश के लिए

my_func? 

या

?my_func 

साथ जाना।

मैं

my_func?? 

(के रूप में @rohan द्वारा टिप्पणी की) का उपयोग कर docstring के लिए से बचने और केवल इसका इस्तेमाल -OO साथ अजगर चल बाहर स्ट्रिप्स कि docstrings स्रोत कोड देखने के