Cómo Generar Documentación en JavaScript

From Wiki de Caballero
Revision as of 00:49, 25 May 2014 by Felipe (talk | contribs) (Created page with "==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 lo...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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. (Opcional) Descargar DocStrap de https://github.com/terryweiss/docstrap/archive/master.zip.
  5. (Opcional) Descomprimir DocStrap en el directorio del primer paso.

Uso

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