मैं एक ऐसे प्रोजेक्ट पर काम कर रहा हूं जिसके लिए अजीब दस्तावेज़ीकरण की आवश्यकता है। मेरे जावा दिनों में, मुझे लगता है कि ग्रहण/आईडीईए में जावाडोक अनुपालन के लिए जांच किए गए लिंटर्स हैं; क्या कोई समकक्ष है जो अजीब दस्तावेज शैली पालन के लिए जांच करता है?क्या कोई पाइथन फ़ाइल को गंदे दस्तावेज़ीकरण शैली पालन की जांच करने के लिए कोई तरीका नहीं है?
मुझे पीईपी 257 के बारे में पता है, लेकिन ऐसा लगता है कि यह नकली दस्तावेज़ीकरण के लिए कोई विशिष्ट जांच नहीं है।
पिलिंट इसका समर्थन करता प्रतीत होता है। pylint.extensions.docparams पर एक नज़र डालें।
इसे समेटने के लिए। आप अपने .pylintrc के मास्टर खंड में
load-plugins=pylint.extensions.docparams
जोड़कर pylint के इस चेकर को सक्रिय करें।
इस चेकर पुष्टि करता है कि सभी कार्य, विधि, और निर्माता docstrings
मापदंडों के प्रलेखन और उनके प्रकारों
वापसी मान और उसके प्रकार
अपवादों में शामिल उठाया
असल pydocstyle (पूर्व pep257) numpy docstring सम्मेलन के लिए recently added support। हालांकि, यह सही नहीं है, मुझे लगता है कि यह आप जो हासिल करना चाहते हैं उसके सबसे नज़दीकी हैं और यह शायद निकट भविष्य में सुधार होगा।
pydocstyle --convention=numpy example.py
कि चेकर numpy (स्फिंक्स जैसे अन्य लोगों के बीच) शैली को संभाल सकता है और उन चीजों की जांच कर सकता है, लेकिन मुझे नहीं लगता कि यह उन अन्य शैलियों से अलग करने का एक तरीका है। उदाहरण के लिए, यदि आप स्फिंक्स प्रलेखन के साथ कोड लिखते हैं कि लिटर अभी भी कहेंगे कि यह ठीक था, भले ही आप केवल numpy शैली चाहते हैं - मुझे एक विशेष दस्तावेज़ीकरण शैली निर्दिष्ट करने का कोई तरीका नहीं दिख रहा है – Andrew
@Andrew, मुझे खेद है कि ऐसा लगता है कि मुझे याद आया अनुपालन के उस हिस्से को ध्यान में रखते हुए, मैंने अपना जवाब अपडेट कर दिया है। –