फंक्शन के बारे में जानकारी या दस्तावेज़ीकरण डॉकस्ट्रिंग्स में रखा जाता है। डॉकस्ट्रिंग्स लिखते समय निम्न दिशानिर्देशों का पालन किया जाना चाहिए:
- पहली पंक्ति हमेशा ऑब्जेक्ट के उद्देश्य का संक्षिप्त, संक्षेप सारांश होनी चाहिए। संक्षिप्तता के लिए, इसमें ऑब्जेक्ट का नाम या प्रकार स्पष्ट रूप से नहीं बताया जाना चाहिए। यह पंक्ति बड़े अक्षर से शुरू होनी चाहिए और पूर्ण विराम से समाप्त होनी चाहिए।
- यदि दस्तावेज़ीकरण स्ट्रिंग में अधिक पंक्तियाँ हैं, तो दूसरी पंक्ति खाली होनी चाहिए, जो सारांश को शेष विवरण से दृश्य रूप से अलग करती है।
Sphinx
Sphinx सबसे लोकप्रिय पायथन दस्तावेज़ीकरण टूल है। यह reStructuredText मार्कअप भाषा को HTML, LaTeX (प्रिंट करने योग्य PDF संस्करणों के लिए), मैनुअल पेज और सादे पाठ सहित कई आउटपुट प्रारूपों में परिवर्तित करता है।
जब चलाया जाता है, तो Sphinx आपके कोड को आयात करता है और पायथन की इंट्रोस्पेक्शन सुविधाओं का उपयोग करके सभी फंक्शन, मेथड और क्लास सिग्नेचर निकालता है। यह साथ में डॉकस्ट्रिंग्स भी निकालता है, और इसे आपके प्रोजेक्ट के लिए अच्छी तरह से संरचित और आसानी से पढ़ने योग्य दस्तावेज़ीकरण में संकलित करता है।
