के लिए जावाडोक-जैसे दस्तावेज़ीकरण क्या सी ++ के लिए जावाडॉक जैसे समान दस्तावेज उत्पादन प्रणाली हैं? जावाडोक अच्छा उत्पादन पैदा करता है; यह बहुत अच्छा होगा अगर आप अन्य भाषाओं में ऐसा कुछ इस्तेमाल कर सकते हैं।सी ++
कई उपकरण है कि सी के लिए JavaDoc की तरह काम करता हैं ++ सबसे लोकप्रिय उपकरण शायद Doxygen है। यह जावाडॉक जैसी टिप्पणियों, और कई भाषाओं (जैसे, सी ++, सी, जावा, ऑब्जेक्टिव-सी, पायथन, पीएचपी, सी #) को संभाल सकता है। सीएसएस का उपयोग कर एचटीएमएल आउटपुट की शैली को ट्वीव करने के लिए इसका बहुत अच्छा समर्थन है (उदाहरण के लिए users list देखें)।
दो महत्वपूर्ण मुद्दों जब प्रलेखन प्रणाली को चुनने यकीन है कि यह करने के लिए
डॉक्सिजन के साथ हमारा अनुभव यह है कि इसे स्थापित करना और उपयोग करना बहुत आसान है, और परिणामी आउटपुट ट्विक करने के लिए काफी आसान है। दुर्भाग्यवश, डॉक्सिजन सही नहीं है, इसलिए कुछ मामलों में क्विर्क या बग के आसपास काम करना जरूरी है जहां डॉक्सिजन पार्सर टूट जाता है। अपने सभी जेनरेट किए गए दस्तावेज़ों का ध्यानपूर्वक निरीक्षण करना सुनिश्चित करें।
आप जावाडोक विशेष रूप से उपयोग नहीं कर सकते Doxygen
क्यूटी आधारित सी ++ परियोजनाओं के लिए qdoc भी है। http://doc-snapshot.qt-project.org/qdoc
मैं अपने पायथन परियोजनाओं के लिए बस Sphinx का उपयोग शुरू कर रहा हूं। इसका होम पेज कहता है "सी/सी ++ पहले ही समर्थित है"।
यह "reStructuredText" नामक हल्के मार्कअप का उपयोग करता है।
मैंने अभी अपनी पाइथन परियोजनाओं के लिए इसका उपयोग करना शुरू कर दिया है, और आउटपुट के रूप में बहुत कुछ देखा है।
पार्सर को तोड़ने के संबंध में मुझे पता चला है कि एक्सएमएल टिप्पणी का उपयोग करने के बाद से मेरी समस्याएं ठीक हो रही हैं, लेकिन फिर फिर भी कई संपादकों और आईडीई बॉक्स के बाहर उपलब्ध समर्थन नहीं हैं। –