I've been heavily using jsdoc3 with docstrap , however it requires a large amount of third-party libraries to generate documentation with node and grunt , someone knows a robust alternative (which has a specification level equal to or even better and contains fewer dependencies for generating documentation)?
Options for generating documentation for javascript libraries
4
asked by anonymous 16.02.2014 / 05:49
2 answers
2
There are a few other libraries that generate documentation from jsdoc3 code, but most will require you to configure the environment for it to work. Take into account that in addition to reading the source code, a library with this function would have to save many files from the final documentation, and this is quite complicated to do with pure Javascript inside a browser or else using only .bat or .sh file.
I personally prefer jsdoc3, but if you really want to test other alternatives (which I personally have not tested but I know they exist), follow a list
16.02.2014 / 06:27
1
I use and recommend the link is very easy to use and quite complete.
It generates the documentation from the comments in the code, in a format similar to the JSDoc:
Classes
/**
* Descrição da classe.
*
* @class MinhaClasse
* @constructor
*/
Methods
/**
* Descrição do método. Como qualquer outro comentário,
* podem ocorrer quebras de linha sem problema.
*
* @method nomeMetodo
* @param {String} foo Parâmetro 1
* @param {Object} config Objeto de configuração
* @param {String} config.name Nome do objeto de config
* @param {Function} config.callback Callback do objeto de configuração
* @param {Boolean} [extra=false] Parâmetro extra, opcional
* @return {Boolean} Retorna true se bem sucedido
*/
To generate documentation, just run yuidoc <camindo de entrada> .
For more options, see English documentation .
27.02.2014 / 00:10