क्या जावास्क्रिप्ट कोड टिप्पणी करने के लिए कोई उपकरण है?

Question

वहाँ जावास्क्रिप्ट टिप्पणी के रूप में यह ग # भूत दस्तावेज़ की तरह है के लिए किसी भी उपकरण है।

/// <summary> 
/// Method to calculate distance between two points 
/// </summary> 
/// <param name="pointA">First point</param> 
/// <param name="pointB">Second point</param> 
function calculatePointDistance(pointA, pointB) 
{ 
    ... 
} 

ऊपर दिए गए टिप्पणियों को स्वचालित रूप से जोड़ने के लिए कोई टूल है। सी # कोड भूत दस्तावेज़ में पसंद आया:

/// <summary> 
/// Method to calculate distance between two points 
/// </summary> 
/// <param name="pointA">First point</param> 
/// <param name="pointB">Second point</param> 
private void calculatePointDistance(pointA, pointB) 
{ 
    ..... 
} 

मैं क्लाइंट साइड में इसी तरह करना चाहते हैं, जावास्क्रिप्ट

Answer 1

हाँ (लेकिन अधिक जावाडोक की तरह) - look at JSDoc मूल रूप से आप में जावाडोक की तरह विशेष सिंटैक्स का उपयोग करें आपकी टिप्पणियां उदा @param निम्न उदाहरण में और उसके बाद पार्सर की तरह आप

/** 
* Shape is an abstract base class. It is defined simply 
* to have something to inherit from for geometric 
* subclasses 
* @constructor 
*/ 
function Shape(color){ 
    this.color = color; 
} 

Answer 2

मैं व्यक्तिगत रूप से उपयोग नहीं किया है के लिए अच्छी लग रही HTML आउटपुट उत्पन्न होगा, लेकिन jsdoc-toolkit होने के लिए क्या आप के बाद कर रहे हैं लगता है।

Answer 3

संक्षिप्त उत्तर कोई कुछ भी नहीं है कि प्रलेखन को स्वचालित है है। आपको प्राप्त होने वाले बंद होने पर jsdoc-toolkit जैसी कुछ चीज़ों के साथ मैन्युअल रूप से टिप्पणियां जोड़ती हैं जो दस्तावेज़ों को HTML पृष्ठों में बनाने की अनुमति देती है।

वहाँ जावास्क्रिप्ट के लिए जावास्क्रिप्ट के लिए IntelliSense प्रलेखन के साथ-साथ, जो इस तरह दिखता है (नोटिस यह समारोह के अंदर यह है)

function example(var myParameter){ 
    /// <summary>This is an example function</summary> 
    /// <param name="myParameter" type="String">All your string are belong to us.</param> 
    /// <returns type="Boolean" /> 

    return !!myParameter; 
} 

तुम भी जावास्क्रिप्ट फ़ाइलों के लिए के टुकड़े बना सकते हैं। मैं बस कुछ स्निपेट बनाना होगा आम दस्तावेजों (किसी भी प्रकार आप पसंद करते हैं) को भरना और फिर तुम सिर्फ टुकड़ा टाइप कर सकते हैं और यह आपके लिए प्रलेखन के अधिकांश में भर जाएगा।

Answer 4

मैं जावास्क्रिप्ट के लिए उपयोग नहीं किया है, लेकिन Doxygen has a filter है कि यह (कम से कम कुछ हद तक) के लिए अनुमति देता जावास्क्रिप्ट दस्तावेज़ के लिए इस्तेमाल किया जा। यह देखने लायक हो सकता है, खासकर अगर आप अन्य भाषाओं का उपयोग कर रहे हैं जो डॉक्सिजन द्वारा समर्थित हैं, तो आपके पास सब कुछ के लिए एक उपकरण हो सकता है।

ऐसा नहीं है कि JSUnit इसके प्रलेखन के लिए Doxygen का उपयोग करता प्रतीत होता है।

Answer 5

सैंडकैसल रूप में अच्छी तरह जावा स्क्रिप्ट का समर्थन करने के लिए, http://blogs.msdn.com/sandcastle/archive/2007/06/28/scriptdoc-1-0-for-extractiong-javascript-code-comments-is-now-available-at-codeplex.aspx देख प्रतीत होता है। मैं इसे सी # के लिए उपयोग करता हूं क्योंकि एनडीओसी प्रोजेक्ट टोस्ट है, लेकिन अभी तक जावास्क्रिप्ट के लिए कोशिश नहीं की है। मैं ऊपर वर्णित जेएसडीओसी का उपयोग करता था।

Answer 6

मुझे आश्चर्य है कि क्यों कोई भी उल्लेख किया DocStubsJS