Difference between revisions of "Cómo Generar Documentación en JavaScript"

From Wiki de Caballero
Jump to navigation Jump to search
Line 17: Line 17:


====Uso con DocStrap====
====Uso con DocStrap====
===Referencias===
* http://usejsdoc.org/, cómo usar JSDoc.

Revision as of 01:07, 25 May 2014

JSDoc

Una forma de documentar JavaScript es usar JSDoc para generar la documentación en html. Este software hace uso de una sintaxis similar a JavaDoc. A continuación los pasos para instalarlo y usarlo fácilmente.

Instalación

  1. Crear directorio para mantener todo lo relacionado con JSDoc en /opt/local/etc/jsdoc (directorio sugerido).
  2. Descargar JSDoc de https://github.com/jsdoc3/jsdoc/archive/master.zip.
  3. Descomprimir en el directorio creado en el primer paso.
  4. Agregar el ejecutable de JSDoc al PATH. Para esto se puede crear un link del ejecutable, por ejemplo corriendo el siguiente comando
    sudo ln -s /opt/local/etc/jsdoc/jsdoc-3.2.2/jsdoc /usr/local/bin/jsdoc.
  5. (Opcional DocStrap) Descargar DocStrap de https://github.com/terryweiss/docstrap/archive/master.zip.
  6. (Opcional DocStrap) Descomprimir DocStrap en el directorio del primer paso.
  7. (Opcional DocStrap) Crear una variable que guarde el directorio donde está ubicado DocStrap.

Uso

Uso normal

Uso con DocStrap

Referencias

Retrieved from "http://wiki.caballero.co/index.php?title=Cómo_Generar_Documentación_en_JavaScript&oldid=325"