क्या विजुअल स्टूडियो के पास जावाडोक-स्टाइल टिप्पणियों के लिए एचटीएमएल दस्तावेज उत्पन्न करने का विकल्प है?

Question

क्या विजुअल स्टूडियो के पास जावाडोक-स्टाइल टिप्पणियों के लिए एचटीएमएल दस्तावेज उत्पन्न करने का विकल्प है? यदि हां, तो इसे पूरा करने के लिए कौन से कदम जरूरी हैं?

ब्लूजे में जावाडॉक-स्टाइल टिप्पणियों को एक HTML फ़ाइल में अनुवाद करने का विकल्प है। जावा में, http://www.time-tripper.com/uipatterns/Patterns/Titled_Sections/javadoc.gif http://www.time-tripper.com/uipatterns/Patterns/Titled_Sections/javadoc.gif

Answer 1

आप वास्तव में JavaDoc मतलब है: BlueJ उपयोग करने के लिए जावा मैं दृश्य स्टूडियो के साथ भी ऐसा करना चाहते हैं

निम्न चित्र की तरह पता चलता है? यदि ऐसा है, तो मुझे विश्वास नहीं है - केवल javadoc का उपयोग करें। विजुअल स्टूडियो वास्तव में जावा का समर्थन नहीं करता है।

यदि आपका मतलब सी # एक्सएमएल दस्तावेज टिप्पणियां है, तो आप एक्सएमएल फ़ाइल बनाने के लिए प्रोजेक्ट गुणों को बदल सकते हैं, और फिर HTML (या chm आदि) बनाने के लिए NDoc (बंद कर दिया गया) या Sandcastle का उपयोग करें। स्वीकार्य रूप से यह उतना आसान नहीं है जितना हो सकता है।

संपादित करें: यदि आप सी ++ का उपयोग कर रहे हैं, तो आपको शायद Doxygen पर देखना चाहिए। विजुअल स्टूडियो प्लगइन्स हो सकते हैं, लेकिन आप अपनी बिल्ड प्रक्रिया के हिस्से के रूप में केवल डॉक्सीजन को चलाने से सबसे अच्छे हो सकते हैं। यदि आप सी ++/सीएलआई का उपयोग कर रहे हैं तो सी # एक्सएमएल टिप्पणियों के कुछ समकक्ष हो सकते हैं, लेकिन मुझे इसकी जानकारी नहीं है।

Answer 2

आप हाथ से टिप्पणियां दर्ज करने, या मेरे एडिन, Atomineer Pro Documentation का उपयोग करके अधिकांश काम करने के लिए जावाडोक-संगत टिप्पणी शैली का उपयोग कर सकते हैं। फिर बाहरी दस्तावेज उत्पन्न करने के लिए, doxygen का उपयोग करें, जो खुशी से javadoc पढ़ता है।

विकल्प (जैसा कि जॉन ने कहा है) XmlDoc प्रारूप टिप्पणियों का उपयोग करने के लिए है, जिसका उपयोग विजुअल स्टूडियो (इंटेलिजेंस टूलटिप्स के लिए), एटमिनर, सैंडकासल और डॉक्सीजन द्वारा किया जा सकता है। यह एक कम मानव-पठनीय प्रारूप है, लेकिन आपको विजुअल स्टूडियो पर्यावरण के भीतर महत्वपूर्ण फायदे देता है, इसलिए यह थोड़ा अधिक लचीला है।

दोनों दृष्टिकोण, सी # के लिए काम करेगा C++, C