jQuery प्लगइन दस्तावेज करने के लिए कौन से टूल्स उपलब्ध हैं?

Question

मैंने हाल ही में कुछ jQuery प्लगइन्स बनाने शुरू कर दिए हैं और मुझे उन दस्तावेजों को उत्पन्न करने वाले दस्तावेज़ों के साथ दस्तावेज करना मुश्किल लगता है। मैंने कोशिश की है: JSDoc, JSDoc-toolkit, JGrouse और एक वेब-आधारित टूल भी। मेरा सबसे बड़ा सिरदर्द यह है कि मेरे प्लग-इन को एक बड़े अज्ञात फ़ंक्शन के रूप में कोड किया गया है, और मुझे यह पता लगाने में परेशानी हो रही है कि मैं क्या कर रहा हूं, या इसे पूरी तरह से अनदेखा कर सकता हूं और मुझे विधियों के लिए दस्तावेज़ टैग में टाइप करने देता हूं , वस्तुओं, आदि ..

क्या कोई अन्य उपकरण है जो jQuery प्लगइन्स को दस्तावेज करने में मदद कर सकता है?

धन्यवाद, सैंड्रो

Answer 1

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

Answer 2

जावास्क्रिप्ट प्रलेखन उपकरण अभी भी अपेक्षाकृत अपरिपक्व हैं, इसलिए यहां 50 + लोगों वहाँ कहते हैं JavaDoc लिए कर रहे हैं की तरह है, और लोगों को है कि मौजूद jQuery प्लग की तरह जटिल मामलों को संभाल नहीं है नहीं कर रहे हैं -ins (या कम से कम मैंने कभी देखा है)।

हालांकि, जावास्क्रिप्ट एक बेहद लचीली भाषा है, इसलिए आप बस अपने प्लग-इन को फिर से लिख सकते हैं जिससे आपके दस्तावेज़ टूल को खुश कर दिया जा सके।

उदाहरण के लिए, के बजाय:

(function($) { 
    $.yourMethod = function() {/* do something */} 
})(jQuery); 

तुम कर सकते हो:

function yourMethod = function() { 
    /* do something */ 
} 

(function($) { 
    $.yourMethod = yourMethod; 
})(jQuery); 
delete yourMethod 

या बस:

jQuery.yourMethod = function() { 
    /* do something */ 
} 

उन दो विकल्प सही मायने में समान नहीं हैं; पहला कोई भी आपके मौजूदा विधि को ओवरराइट करेगा, और बाद वाले में मानक प्लग-इन प्रारूप की अच्छी "गोपनीयता" नहीं होगी। इस प्लग-इन के बारे में आप जो लिख रहे हैं उसके आधार पर, ये समस्याएं आपके लिए महत्वपूर्ण नहीं हो सकती हैं या इससे कोई फर्क नहीं पड़ता।

यदि वे नहीं करते हैं, तो आपके कोड को फिर से स्टाइल करना आपके जेएसडीओसी को पारदर्शी बनाने का एक व्यवहार्य तरीका हो सकता है। यदि नहीं ... अच्छी किस्मत एक परिपक्व पर्याप्त JSDoc उपकरण की खोज (या अपने स्वयं लिख) :-)

Answer 3

मैं दृश्य स्टूडियो एक्सएमएल टिप्पणियों का उपयोग: http://weblogs.asp.net/bleroy/archive/2007/04/23/the-format-for-javascript-doc-comments.aspx

Answer 4

मैं इस तरह से Doxygen प्रयोग किया है:

/** @cond */ 

jQuery(function($){ 

    $.fn.TestFunction = function(){ testvar="test1";test("test2");alert(testvar); } 

/** @endcond */ 

    /** DoSth Function */ 
    function test(testvar) 
    { 
     alert(testvar); 
     var testvar="test3"; 
     alert(testvar); 
    } 

/** @cond */ 

    delete test; 
}); 

/** @endcond */