¿Qué formato de documentación de comentarios es mejor para JavaScript?

Question

¿Hay algún formato de documentación de comentarios para JavaScript y procesador para este formato que genera documentación HTML?

Actualmente estoy usando los comentarios de VSDoc xml para proporcionar ayuda de IntelliSense en el momento del desarrollo, pero como sé, no hay generador de documentación para tales comentarios. Entonces, alternativamente, mi pregunta puede sonar como: ¿Hay alguna utilidad que traduzca los comentarios de VSDoc de los archivos de JavaScript a HTML?

Answer 1

¿Ha mirado la documentación generada automáticamente de JavaDoc o VSDoc o JSDoc o algo por el estilo?

Son todos feos y no legibles.

La solución es doble

• annotate your code with docco
• hacer su API de documentación escrita a mano.

Existe una tercera opción que consiste en revolucionar la forma en que hacemos la documentación generada automáticamente, si es que puede hacerlo.

Answer 2

He usado Natural Docs para algunos proyectos. La sintaxis es buena para leer en línea, pero como no tiene "soporte de lenguaje completo" para JavaScript, debe ser un tanto explícito sobre cada función/constante/clase/lo que quiera documentar.

Answer 3

Hay una utilidad que analiza los archivos Javascript y da salida a la misma NDoc formato XML y el uso castillo de arena: AjaxDoc

De esta manera se obtiene el intellisense de VS los mismos comentarios y puede dar salida a cualquier formato que desee.