Quels sont les outils disponibles pour documenter les plugins jQuery?

Question

J'ai récemment commencé à créer des plugins jQuery et j'ai du mal à les documenter avec les outils de génération de documentation que j'ai trouvés. J'ai essayé: JSDoc, JSDoc-toolkit, JGrouse et un outil basé sur le Web aussi. Mon plus gros casse-tête est que mes plug-ins sont codés comme une grande fonction anonyme, et j'ai du mal à obtenir les outils pour reconnaître ce que je fais, ou l'ignorer complètement et me laisser taper les balises de documentation pour les méthodes , objets, etc.

Existe-t-il d'autres outils pouvant vous aider à documenter les plugins jQuery?

Merci, Sandro

Answer 1

Avez-vous eu un coup d'œil à Natural Docs? Il pourrait ne pas avoir beaucoup de soutien explicite pour JavaScript, mais il fait quand même un très bon travail. Bien sûr, vous pouvez le tromper pour ne pas comprendre le code, mais si vous jouez bien avec, cela peut être un sacré outil.

Answer 2

outils de documentation Javascript sont encore relativement immature, donc il n'y a pas plus de 50 enfants comme il y a pour JavaDoc dire, et ceux qui existent ne gèrent pas les cas complexes comme des plug jQuery -ins (ou au moins aucun de ceux que j'ai jamais vu).

Cependant, Javascript est un langage extrêmement flexible, donc pourrait simplement juste réécrire vos plug-ins d'une manière qui rendra votre outil de documentation heureux.

Par exemple, au lieu de:

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

vous pourriez faire:

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

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

ou tout simplement:

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

Ces deux options ne sont pas vraiment identiques; le premier remplacera toute fonction yourMethod existante, et cette dernière n'aura pas la belle "confidentialité" du format de plug-in standard. En fonction de ce que vous écrivez pour ce plug-in, ces problèmes peuvent ou non vous importer. Si ce n'est pas le cas, redessiner votre code peut être une manière viable de rendre votre JSDoc analysable. Sinon ... bonne chance pour trouver un outil de JSDoc assez mature (ou écrire votre propre) :-)

Answer 3

utiliser les commentaires XML Visual Studio: http://weblogs.asp.net/bleroy/archive/2007/04/23/the-format-for-javascript-doc-comments.aspx

Answer 4

J'utilisé doxygen ainsi:

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