Web BizarroWeb Bizarro

Suscríbete a nuestro Newsletter

X

Únete a nuestra lista de correos para recibir semanalmente actualizaciones de nuestro contenido.

Como documentar tus JavaScript

Como documentar tus JavaScript 10.JAN.14

Alvaro José Rios Ch
Fundador WebBizarro

Tener la mayor cantidad de código documentado es una practica obligatoria para los desarrolladores de software, con más razón si deseamos distribuirlo entre la comunidad ya que un código sin una documentación clara no sera muy utilizado.

Pero como hacer una buena documentación sin que nos quite mucho tiempo, bueno hay muchas herramientas para diferentes lenguajes que nos permiten hacerlo sin mucho esfuerzo y hoy les quiero mostrar ApiDoc, una herramienta para documentar archivos JavaScript de una forma muy simple, solo debes instalar la aplicación mediante npm y luego por supuesto colocar la documentación de lo que hace tu código, como por ejemplo.

/** 
* @api {get} /user/:id Request User information
* @apiName GetUser
* @apiGroup User
* 
* @apiParam {Number} id Users unique ID.
* 
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*/

Luego de eso al ejecutar un comando en la consola ya estar listo un minisitio, como en este ejemplo, con toda la documentación de tu JavaScript y además si has hecho cambios en la documentación la herramienta automáticamente generara una nueva versiónde esta y mantendrá las anteriores permitiéndote tener un historial de los cambios que has hecho.

Aunque esta orientada a documentar RESTFUL Web API es una excelente herramienta que nos ayudara a crear proyectos más limpios y con una mejor presentación.