Difference between revisions of "Cómo Generar Documentación en JavaScript"
Jump to navigation
Jump to search
(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...") |
|||
| Line 6: | Line 6: | ||
# Descargar [https://github.com/jsdoc3 JSDoc] de https://github.com/jsdoc3/jsdoc/archive/master.zip. | # Descargar [https://github.com/jsdoc3 JSDoc] de https://github.com/jsdoc3/jsdoc/archive/master.zip. | ||
# Descomprimir en el directorio creado en el primer paso. | # Descomprimir en el directorio creado en el primer paso. | ||
# (Opcional) Descargar [http://terryweiss.github.io/docstrap/ DocStrap] de https://github.com/terryweiss/docstrap/archive/master.zip. | # Agregar el ejecutable de JSDoc al PATH. Para esto se puede crear un link del ejecutable, por ejemplo corriendo el siguiente comando<br> <code>sudo ln -s /opt/local/etc/jsdoc/jsdoc-3.2.2/jsdoc /usr/local/bin/jsdoc</code>. | ||
# (Opcional) Descomprimir DocStrap en el directorio del primer paso. | # (Opcional DocStrap) Descargar [http://terryweiss.github.io/docstrap/ DocStrap] de https://github.com/terryweiss/docstrap/archive/master.zip. | ||
# (Opcional DocStrap) Descomprimir DocStrap en el directorio del primer paso. | |||
# (Opcional DocStrap) Crear una variable que guarde el directorio donde está ubicado DocStrap. | |||
===Uso=== | ===Uso=== | ||
====Uso normal==== | |||
====Uso con DocStrap==== | |||
Revision as of 01:06, 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
- Crear directorio para mantener todo lo relacionado con JSDoc en
/opt/local/etc/jsdoc(directorio sugerido). - Descargar JSDoc de https://github.com/jsdoc3/jsdoc/archive/master.zip.
- Descomprimir en el directorio creado en el primer paso.
- 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. - (Opcional DocStrap) Descargar DocStrap de https://github.com/terryweiss/docstrap/archive/master.zip.
- (Opcional DocStrap) Descomprimir DocStrap en el directorio del primer paso.
- (Opcional DocStrap) Crear una variable que guarde el directorio donde está ubicado DocStrap.