Quali strumenti sono disponibili per la documentazione dei plugin jQuery?

Question

Ho recentemente iniziato a creare alcuni plugin jQuery e trovo difficile documentarli con gli strumenti di generazione di documentazione che ho trovato. Ho provato: JSDoc, JSDoc-toolkit, JGrouse e anche uno strumento basato sul web. Il mio più grande mal di testa è che i miei plug-in sono codificati come una grande funzione anonima, e ho difficoltà a trovare gli strumenti per riconoscere ciò che sto facendo, o ignorarlo del tutto e lasciami digitare i tag della documentazione per i metodi , oggetti, ecc.

Esistono altri strumenti che potrebbero essere utili per documentare i plugin jQuery?

Grazie, Sandro

Answer 1

Avete dato un'occhiata al Natural Docs? Potrebbe non avere molto supporto esplicito per JavaScript, tuttavia fa comunque un buon lavoro. Ovviamente puoi ingannarlo per non capire il codice, ma se giochi bene con esso, può essere uno strumento incredibile.

Answer 2

Javascript strumenti di documentazione sono ancora relativamente immaturo, quindi non ci sono oltre 50 quelli che ci sono per esempio JavaDoc, e quelli che esistono non gestire casi complessi come spina jQuery -in (o almeno nessuno di quelli che abbia mai visto).

Tuttavia, Javascript è un linguaggio estremamente flessibile, quindi è possibile semplicemente riscrivere i plug-in in un modo che rende felice lo strumento di documentazione.

Per esempio, invece di:

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

si potrebbe fare:

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

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

o semplicemente:

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

Queste due opzioni non sono realmente identiche; il primo sovrascriverà qualsiasi funzione yourMethod esistente e quest'ultimo non avrà la "privacy" del formato plug-in standard. A seconda di cosa stai scrivendo questo plug-in, questi problemi potrebbero non avere importanza per te.

In caso contrario, il re-styling del codice potrebbe essere un metodo valido per rendere analizzabile il tuo JSDoc. Se no ... buona fortuna trovare uno strumento JSDoc abbastanza maturo (o scrivere il proprio) :-)

Answer 3

Io uso di Visual Studio commenti XML: http://weblogs.asp.net/bleroy/archive/2007/04/23/the-format-for-javascript-doc-comments.aspx

Answer 4

Ho usato doxygen in questo modo:

/** @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 */