2009-03-11 31 views
19

के लिए कोड प्रलेखन पायथन स्रोत कोड दस्तावेज करने के लिए सम्मेलनों और उपकरणों पर क्या है?पाइथन

उत्तर

9

Epydoc भी स्रोत कोड का दस्तावेजीकरण के लिए एक अच्छा उपकरण है, और पार संदर्भित कक्षाएं, मॉड्यूल, चर, आदि, HTML, PDF, लेटेक्स में संभालती है। कुछ अच्छे वर्ग विरासत आरेख भी खींचता है। इसका उपयोग कई खुली स्रोत परियोजनाओं द्वारा किया जाता है, इसलिए यह काफी सक्रिय रूप से विकसित किया गया है।

35

सम्मेलन: PEP 257 और PEP 8। ध्यान दें, कि docstrings प्रलेखन पैदा करने के लिए reStructuredText

उपकरण में लिखा जा सकता है: उदाहरण के Sphinx

16

सबसे पहले, पुनर्गठित पाठ प्रारूप का उपयोग करके अपने दस्तावेज़ों में टिप्पणियां दें।

दूसरा, sphinx प्राप्त करें।

तीसरा, autodoc extension का उपयोग करने वाली एक अनुक्रमणिका बनाएं।

फिर, वास्तव में अच्छा दस्तावेज़ प्राप्त करने के लिए स्फिंक्स चलाएं।

1

डॉक्सिजन के साथ डॉक्सिपी फ़िल्टर का उपयोग करना अच्छी बात है