इंटरैक्टिव दुभाषिया के संकेत पर help(yourmodule) करने वाले किसी के बारे में सोचें - वे क्या चाहते हैं जानना चाहते हैं? (निकालने और जानकारी प्रदर्शित के अन्य तरीकों के बारे में जानकारी की राशि के मामले में मोटे तौर पर help के बराबर हैं)। तो तुम x.py में पूछना चाहते हैं तो:
"""This module does blah blah."""
class Blah(object):
"""This class does blah blah."""
तो:
>>> import x; help(x)
शो:
Help on module x:
NAME
x - This module does blah blah.
FILE
/tmp/x.py
CLASSES
__builtin__.object
Blah
class Blah(__builtin__.object)
| This class does blah blah.
|
| Data and other attributes defined here:
|
| __dict__ = <dictproxy object>
| dictionary for instance variables (if defined)
|
| __weakref__ = <attribute '__weakref__' of 'Blah' objects>
| list of weak references to the object (if defined)
जैसा कि आप देख, भी वर्ग (और कार्यों पर विस्तृत जानकारी है, हालांकि मैं मैं यहां एक नहीं दिखा रहा हूं) पहले से ही उन घटकों के डॉकस्ट्रिंग से शामिल है; मॉड्यूल की अपनी docstring उन्हें बहुत सरसरी तौर पर वर्णन करना चाहिए (यदि सभी) और नहीं बल्कि कुछ doctested उदाहरण (केवल कार्य करता है और कक्षाओं में आदर्श doctested जाना चाहिए था उदाहरण की तरह साथ आदर्श, क्या एक पूरे के रूप मॉड्यूल आप के लिए क्या कर सकते हैं की एक संक्षिप्त सारांश पर ध्यान केंद्रित थिट डॉकस्ट्रिंग्स)।
मुझे नहीं पता कि लेखक नाम और कॉपीराइट/लाइसेंस जैसे मेटाडेटा मॉड्यूल के उपयोगकर्ता की सहायता कैसे करता है - यह टिप्पणियों में जा सकता है, क्योंकि इससे मॉड्यूल का पुन: उपयोग या संशोधित करने पर विचार करने में कोई मदद कर सकता है।
स्रोत
2010-03-31 23:28:02
तो, क्या मॉड्यूल के शीर्ष पर टिप्पणियों में लेखक, कॉपीराइट इत्यादि शामिल करना प्रथागत है? –
@ 007brendan, यह बहुत आम प्रथा है, हां। –
@IfLoop मुझे संदेह है कि ऐसे उपयोगकर्ता हैं जो दुभाषिया में 'सहायता()' विधि का उपयोग करते हैं जो उपयोगकर्ताओं को कोड पढ़ते हैं। – confused00