Javadoc en CoffeeScript?

Question

Soy nuevo en CoffeeScript y parece que no puedo encontrar ningún generador de documentos para CoffeeScript que use la sintaxis Javadoc. El único que pude encontrar está disponible como un parche para el compilador de CoffeeScript.

Entonces, ¿qué usa para generar documentación de los comentarios de Javadoc en CoffeeScript o cómo documenta sus argumentos de función y valores de retorno?

Answer 1

Docco es ideal para el estilo de codificación prozedural. Si desea documentar una API, coffeedoc es para usted.

Answer 2

Estoy usando YUIDoc . Puedo agregar comentarios usando una sintaxis similar a Javadoc a mis clases, métodos y eventos. La documentación se imprime como archivos html / css e incluso puede personalizar el diseño de la página.

Consulte este ejemplo de documentación: http://yui.github.com/yuidoc/api/

PS: se basa en Node.JS y necesita instalar el paquete yuidocjs

npm install yuidocjs -g

Answer 3

Las personas que deseen utilizar la documentación de estilo javadoc en coffeescript pueden revisar codo ( http://netzpirat.github.com/codo/ ) que proporciona soporte para un subconjunto de javadoc e infiere automáticamente nombres de clase, nombres de funciones y parámetros del código fuente.

Answer 4

Por lo tanto, la sintaxis JavaDoc nunca ha tenido éxito con los desarrolladores de JavaScript. Hay quienes usan algo así, especialmente Google, pero está en desacuerdo con JS, que no tiene escritura estática y permite cualquier número de argumentos para cualquier función.

Si desea crear una documentación hermosa con CoffeeScript, el estándar es Docco (su página de inicio es un excelente ejemplo). Si desea crear comentarios de estilo JavaDoc para cada función ... bueno, tendrá que crearlos a mano y escapar de ellos con backticks.

Alternativamente, puede trabajar en CoffeeScript hasta que su código esté listo para su lanzamiento, luego documente el JavaScript resultante.