optimize - ¿Hay alguna manera de generar documentación de la API de Javascript como la documentación de la API de la biblioteca de Google Closure?

npm google closure compiler

Question

Estoy tratando de encontrar una herramienta que genere documentación HTML para mi código fuente de Javascript.

¿Alguien sabe si la herramienta que Google usa para generar la interfaz en las siguientes URL es de código abierto? ¿Sería capaz de generar resultados similares?

http://closure-library.googlecode.com/svn/docs/class_goog_proto2_Serializer.html

http://closure-library.googlecode.com/svn/docs/namespace_goog_date.html

http://closure-library.googlecode.com/svn/docs/namespace_goog_events.html

http://closure-library.googlecode.com/svn/docs/class_goog_gears_Database.html

http://closure-library.googlecode.com/svn/docs/class_goog_ui_DatePicker.html

Conozco http://code.google.com/p/jsdoc-toolkit/

Pero me gustaría saber si el generador específico que usa Google está disponible para que lo use para mi propia fuente (que será de código abierto, si eso importa).

Gracias por adelantado...

Answer 1

Google Closure + JSDoc

Como mencionó usted mismo en su comentario, se basan en http://code.google.com/p/jsdoc-toolkit/ para agregar anotaciones especiales utilizadas por el Closure Compiler para la verificación de tipos y otras cosas, pero esto significa que también puede usar JSDoc sobre el código de cierre para generar su documentación. Generar un resultado con la apariencia deseada es solo cuestión de escribir su propia plantilla y hoja de estilo.

Las herramientas de cierre de Google son todas de código abierto, excepto por algunos bits que no se divulgan en este momento. En cualquier caso, puede echar un vistazo a la documentación y al código fuente y ver qué usan para generar Javadocs.

ExtJS + Ext-Doc

Otro de los que posiblemente puedas tener en busca de inspiración y para ver cómo lo hacen es el documento en línea de ExtJS . Me parece un poco confuso navegar al principio, pero te acostumbras bastante rápido. Un proyecto de código abierto, Ext-Doc , genera documentación con un estilo similar, aunque ahora está un poco desactualizado.

YUI Doc

Como mencionó Matthew Manela , YUI Doc también produce bastante buena documentación en línea.

Mi consejo sería elegir JSDoc, ya que es el estándar de facto para muchas herramientas y refleja las prácticas de Java, pero realmente depende de lo que usted desea.

Answer 2

Echa un vistazo a YUI Doc .

Answer 3

Para los que usan ExtJs, github.com/senchalabs/jsduck es increíble.

Para los que no usan ExtJS pero están familiarizados con Ruby, https://github.com/b-studios/doc.js es genial.

Answer 4

Una opción más nueva es http://documentation.js.org/ que usa JSDoc y genera HTML:

Puede ejecutarlo con gulp https://github.com/documentationjs/gulp-documentation

Answer 5

Dossier se está utilizando actualmente (2016) para crear la documentación de la biblioteca de cierre . Es una herramienta fantástica que se construye sobre el compilador Closure, por lo que realmente lee toda la información de tipo usando el compilador y luego genera documentación en lugar de código.

Todavía hay algunas cosas que se están resolviendo sobre la interfaz de usuario de los documentos. Actualmente, la página de documentos de la biblioteca de cierre parece bastante vacía. Para comenzar, debes hacer clic en el símbolo "menú de hamburguesas" en la parte superior izquierda.