¿Qué herramientas están disponibles para documentar los complementos de jQuery?

Question

Recientemente he comenzado a crear algunos plugins de jQuery y me resulta difícil documentarlos con las herramientas de generación de documentación que he encontrado. Lo he intentado: JSDoc, JSDoc-toolkit, JGrouse y también una herramienta basada en web. Mi mayor dolor de cabeza es que mis complementos están codificados como una gran función anónima, y ​​tengo problemas para obtener las herramientas para reconocer lo que estoy haciendo, o ignorarlo por completo y dejarme escribir las etiquetas de documentación para los métodos. , objetos, etc.

¿Hay alguna otra herramienta que pueda ayudar a documentar los complementos de jQuery?

Gracias, Sandro

Answer 1

¿Ha tenido un vistazo a Natural Docs? Puede que no tenga mucho soporte explícito para JavaScript, sin embargo, hace un trabajo bastante bueno de todos modos. Por supuesto, puedes engañarlo para que no entienda el código, pero si juegas bien con él, puede ser una herramienta increíble.

Answer 2

herramientas de documentación de JavaScript son todavía relativamente inmaduro, por lo que no son más de 50 los que hay son de JavaDoc decir, y los que existen no manejar casos complejos como el tapón de jQuery -ins (o al menos ninguno de los que he visto).

Sin embargo, Javascript es un lenguaje extremadamente flexible, por lo que podría solo reescribir los complementos de una manera que haga feliz a su herramienta de documentación.

Por ejemplo, en lugar de:

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

que podría hacer:

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

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

o simplemente:

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

Estas dos opciones no son realmente idénticos; el primero sobrescribirá cualquier función existente de YourMethod, y este último no tendrá la buena "privacidad" del formato de complemento estándar. Dependiendo de para qué está escribiendo este complemento, esos problemas pueden serle importantes o no.

Si no es así, volver a diseñar su código puede ser una forma viable de hacer que su JSDoc sea analizable. Si no es así ... buena suerte para encontrar una herramienta jsdoc suficientemente maduro (o escribir su propia) :-)

Answer 3

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

Answer 4

que utilizan doxygen esta manera:

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