2012-02-13 16 views
13

Estoy buscando documentar el código de JavaScript que desarrollamos y estamos buscando algunos buenos generadores de documentación de JavaScript, ¿alguien tiene alguna sugerencia?Generación de documentación de Javascript

Solíamos utilizar ndoc para crear documentación para nuestro código C# y estamos buscando algo similar para documentar nuestro código js, ​​idealmente algo que se puede ejecutar desde una línea de comando.

gracias de antemano!

+0

Aconsejaría consultar [esta pregunta] (http://stackoverflow.com/questions/1221413/what-tools-are-available-for-documenting-javascript) así como –

Respuesta

10

Puede usar el famoso JSDoc-Toolkit para eso.

jsdoc Toolkit es una aplicación, escrito en JavaScript, por generar automáticamente la plantilla con formato de varias páginas HTML (o XML, JSON, o cualquier otro basado en texto) Documentación a partir comentado código fuente JavaScript .

Y sí, también tiene command line options.

+0

Cosas geniales, lo comprobaré ¡fuera! –

+0

@DaveLister: De nada – Sarfraz

+2

Parece que JSDoc-Toolkit ya no se mantiene. El sitio apunta a 'jsdoc' https://github.com/jsdoc3/jsdoc – luiges90

10

JSDoc es un enfoque para generar documentación desde el JavaScript comentado. Hay muchas variaciones:

  • Fue implementado originalmente en Perl.
  • JSDoc-Toolkit lo conectó a JavaScript, pero requiere Java, ya que utiliza el motor de JavaScript de Rhino escrito en Java.
  • Varias personas lo han portado para que se ejecute directamente en el motor/plataforma de JavaScript node.js, p. node-jsdoc-toolkit.
  • dox también se ejecuta en node.js, combina etiquetas JSDoc-like y markdown markup pero requiere un motor de plantillas separado (como se usa en Stack Overflow y github).

Todos se ejecutan desde la línea de comandos. Elija según sus preferencias de herramientas. Me gusta node.js por su velocidad y la sensación de todo-JavaScript-todo el tiempo. El DailyJS "Hagamos un marco" post on writing documentation describe estas y otras herramientas; desafortunadamente, dox fue revisado radicalmente para solo generar estructuras JSON desde que se escribió.

https://stackoverflow.com/q/1221413/1162195 menciona otros generadores de documentación JavaScript.

+0

gracias por los enlaces @skierpage! –

Cuestiones relacionadas