मुझे पता है कि फ़ंक्शंस, कक्षाएं और मॉड्यूल दस्तावेज करने का मानक तरीका क्या है, लेकिन मैं पैकेज कैसे दस्तावेज करता हूं - क्या मैं __init__.py में कोई डॉकस्ट्रिंग डालता हूं, या कुछ और?एक पायथन पैकेज को कैसे दस्तावेज करें
"""
This is the xyz package.
"""
अब अगर आप पैकेज आयात करते हैं और मदद का उपयोग (:
हाँ, बस एक समारोह या कक्षा टिप्पणी के लिए की तरह, __init__.py फ़ाइल में पहले आइटम एक टिप्पणी स्ट्रिंग होना चाहिए पैकेज), आप अपने डॉक्टरिंग देखेंगे। यहाँ अधिक देखें: http://www.python.org/dev/peps/pep-0257/
देखें PEP257
एक पैकेज पैकेज निर्देशिका में __ init __.py फ़ाइल के मॉड्यूल docstring में दर्ज किया जा सकता है।
दस्तावेजीकरण एक अच्छा विचार है, जब तक आप अपने कोड में कुछ स्पष्ट दस्तावेज़ नहीं है के रूप में समझना महत्वपूर्ण है कि अपने स्रोत पढ़ने ज्यादातर लोगों अजगर समझ जाएगा, तो टिप्पणी या दस्तावेजीकरण की तरह यह है लाइनों
कोशिश व्यर्थ:
a = 1 #this assigns 1 to a
लेकिन एक जटिल कार्य या कक्षा को टिप्पणी या दस्तावेज करना एक अच्छा विचार है।
अंगूठे का सामान्य नियम: कल्पना करें कि अगले व्यक्ति को आपके कोड पर काम करने के लिए एक एक्सएक्सिंग पागल है और वे जानते हैं कि आप कहां रहते हैं।
इस तरह आप हमेशा "सहायक" टिप्पणियां/डॉक्टर
छोड़ देंगे