जावास्क्रिप्ट के लिए कौन सी टिप्पणियां प्रलेखन प्रारूप बेहतर है?

Question

क्या इस प्रारूप के लिए जावास्क्रिप्ट और प्रोसेसर के लिए कोई टिप्पणी दस्तावेज प्रारूप है जो HTML दस्तावेज़ उत्पन्न करता है?

वर्तमान में मैं विकासशील समय में इंटेलिसेन्स सहायता प्रदान करने के लिए वीएसडीओसी एक्सएमएल टिप्पणियों का उपयोग कर रहा हूं, लेकिन जैसा कि मुझे पता है कि ऐसी टिप्पणियों के लिए कोई दस्तावेज जनरेटर नहीं है। तो वैकल्पिक रूप से मेरा प्रश्न इस तरह लगता है: क्या ऐसी कोई उपयोगिता है जो जावास्क्रिप्ट फ़ाइलों से HTML तक VSDoc टिप्पणियों का अनुवाद करती है?

Answer 1

क्या आपने जावाडोक या वीएसडोक या जेएसडीओसी या उसके जैसे कुछ भी ऑटो जनरेट किए गए दस्तावेज़ों को देखा है।

वे सभी बदसूरत और अप्राप्य हैं।

समाधान दो गुना

• annotate your code with docco
• अपने API दस्तावेज़ हाथ लिखा करते हैं।

एक तीसरा विकल्प है जो हम स्वत: जेनरेट किए गए दस्तावेज़ों को क्रांतिकारी बनाने के लिए करते हैं, यदि आप कृपया कर सकते हैं।

Answer 2

मैंने कुछ परियोजनाओं के लिए Natural Docs का उपयोग किया है। वाक्यविन्यास इनलाइन पढ़ने के लिए अच्छा है, लेकिन चूंकि जावास्क्रिप्ट के लिए "पूर्ण भाषा समर्थन" नहीं है, इसलिए आपको प्रत्येक फ़ंक्शन/निरंतर/कक्षा/जो भी आप दस्तावेज़ बनाना चाहते हैं, उसके बारे में कुछ स्पष्ट होना चाहिए।

Answer 3

एक उपयोगिता है कि जावास्क्रिप्ट फ़ाइलों को पार्स करता है और एक ही XML स्वरूप NDoc और सैंडकैसल उपयोग आउटपुट है: AjaxDoc

इस तरह आप एक ही टिप्पणियों से वी.एस. IntelliSense हो और उत्पादन किसी भी प्रारूप आप चाहते हैं कर सकते हैं।