Cómo Generar Documentación en JavaScript - Revision history

Felipe: /* Namespaces */

2015-02-12T15:16:32Z

Namespaces

← Older revision		Revision as of 15:16, 12 February 2015
Line 50:		Line 50:
	===Namespaces===		===Namespaces===
	A continuación un ejemplo de cómo documentar namespaces, se usa @namespace y @memberof (aunque se pueden usar otras etiquetas). No es un ejemplo perfecto ya que la documentación de los requisitos no es muy clara, este ejemplo funciona pero puede ser que hayan cosas que le falten o que le sobren.		A continuación un ejemplo de cómo documentar namespaces, se usa @namespace y @memberof (aunque se pueden usar otras etiquetas). No es un ejemplo perfecto ya que la documentación de los requisitos no es muy clara, este ejemplo funciona pero puede ser que hayan cosas que le falten o que le sobren.

			Este ejemplo se basa parcialmente en [http://stackoverflow.com/questions/19230971/how-do-i-jsdoc-a-nested-objects-methods How do I JSDoc A Nested Object's Methods?].

	<source lang="javascript">		<source lang="javascript">

Felipe at 15:15, 12 February 2015

2015-02-12T15:15:28Z

@@ Line 45: / Line 45: @@
 # Se puede agregar el anterior comando en un archivo ejecutable para cada proyecto que requiera documentación de JavaScript. Se crea un archivo de Bash, se agrega la línea del comando a ejecutar y se cambia el output a la ubicación deseada.
 # En el ejemplo anterior sobre el uso, se usa un archivo de configuración por defecto ubicado en el mismo directorio de DocStrap. Se puede usar el mismo archivo para todos los proyectos o se puede crear un archivo nuevo para cada proyecto en particular. Para esto copiar el archivo por defecto y modificarlo a voluntad, luego se invoca en el comando.
 ==Notas==

Felipe: /* Referencias */

2015-02-12T01:43:49Z

Referencias

← Older revision		Revision as of 01:43, 12 February 2015
Line 52:		Line 52:
	* http://usejsdoc.org/, cómo usar JSDoc.		* http://usejsdoc.org/, cómo usar JSDoc.
	* http://terryweiss.github.io/docstrap/, DocStrap.		* http://terryweiss.github.io/docstrap/, DocStrap.
			* [http://speakingjs.com/es5/ch29.html Chapter 29. JSDoc: Generating API Documentation], una guía práctica

Felipe at 21:09, 11 February 2015

2015-02-11T21:09:38Z

← Older revision		Revision as of 21:09, 11 February 2015
Line 46:		Line 46:
	# En el ejemplo anterior sobre el uso, se usa un archivo de configuración por defecto ubicado en el mismo directorio de DocStrap. Se puede usar el mismo archivo para todos los proyectos o se puede crear un archivo nuevo para cada proyecto en particular. Para esto copiar el archivo por defecto y modificarlo a voluntad, luego se invoca en el comando.		# En el ejemplo anterior sobre el uso, se usa un archivo de configuración por defecto ubicado en el mismo directorio de DocStrap. Se puede usar el mismo archivo para todos los proyectos o se puede crear un archivo nuevo para cada proyecto en particular. Para esto copiar el archivo por defecto y modificarlo a voluntad, luego se invoca en el comando.

	===Referencias===		==Notas==
			* Al momento de documentar, no usar palabras reservadas (aunque hagan parte de otra palabra como functionParam) ya que aparentemente ApiGen se "marea" y no es capaz de tomar la palabra como única.

			==Referencias==
	* http://usejsdoc.org/, cómo usar JSDoc.		* http://usejsdoc.org/, cómo usar JSDoc.
	* http://terryweiss.github.io/docstrap/, DocStrap.		* http://terryweiss.github.io/docstrap/, DocStrap.

Felipe: Felipe moved page Cómo documentar JavaScript to Cómo Generar Documentación en JavaScript: El nombre anterior no transmitía lo que se quería

2015-02-11T21:07:56Z

Felipe moved page Cómo documentar JavaScript to Cómo Generar Documentación en JavaScript: El nombre anterior no transmitía lo que se quería

← Older revision	Revision as of 21:07, 11 February 2015
(No difference)

Felipe: /* Instalación */

2015-02-11T19:25:53Z

Instalación

← Older revision		Revision as of 19:25, 11 February 2015
Line 22:		Line 22:
	<ol>		<ol>
	<li>Descargar [http://terryweiss.github.io/docstrap/ DocStrap] de https://github.com/terryweiss/docstrap/archive/master.zip.</li>		<li>Descargar [http://terryweiss.github.io/docstrap/ DocStrap] de https://github.com/terryweiss/docstrap/archive/master.zip.</li>
	<li>Descomprimir DocStrap en el directorio del primer paso.</li>		<li>Descomprimir DocStrap en el directorio del primer paso (<code>/opt/local/etc/jsdoc</code>).</li>
	<li>		<li>
	Para el uso de DocStrap se usan algunos parámetros como su ubicación, en vez de escribir cada vez los directorios se usan variables para hacerlo más fácil. Para crear estas variables se hace con los siguientes comandos:		Para el uso de DocStrap se usan algunos parámetros como su ubicación, en vez de escribir cada vez los directorios se usan variables para hacerlo más fácil. Para crear estas variables se hace con los siguientes comandos:

Felipe: /* DocStrap */

2015-02-11T18:50:55Z

DocStrap

← Older revision		Revision as of 18:50, 11 February 2015
Line 16:		Line 16:
	Para saber más sobre el uso ejecutar <code>jsdoc --help</code>.		Para saber más sobre el uso ejecutar <code>jsdoc --help</code>.

	===DocStrap===		==DocStrap==
			Se usa para aplicarle un template a JSDoc.

	====Instalación====		===Instalación===
	<ol>		<ol>
	<li>Descargar [http://terryweiss.github.io/docstrap/ DocStrap] de https://github.com/terryweiss/docstrap/archive/master.zip.</li>		<li>Descargar [http://terryweiss.github.io/docstrap/ DocStrap] de https://github.com/terryweiss/docstrap/archive/master.zip.</li>
Line 35:		Line 36:
	</ol>		</ol>

	====Uso====		===Uso===
	El uso es el mismo que el de JSDoc pero se usan ubicaciones de DocStrap, con las variables que se crearon en el punto anterior, se usa de la siguiente manera:		El uso es el mismo que el de JSDoc pero se usan ubicaciones de DocStrap, con las variables que se crearon en el punto anterior, se usa de la siguiente manera:
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
Line 41:		Line 42:
	</syntaxhighlight>		</syntaxhighlight>

	====Recomendaciones====		===Recomendaciones===
	# Se puede agregar el anterior comando en un archivo ejecutable para cada proyecto que requiera documentación de JavaScript. Se crea un archivo de Bash, se agrega la línea del comando a ejecutar y se cambia el output a la ubicación deseada.		# Se puede agregar el anterior comando en un archivo ejecutable para cada proyecto que requiera documentación de JavaScript. Se crea un archivo de Bash, se agrega la línea del comando a ejecutar y se cambia el output a la ubicación deseada.
	# En el ejemplo anterior sobre el uso, se usa un archivo de configuración por defecto ubicado en el mismo directorio de DocStrap. Se puede usar el mismo archivo para todos los proyectos o se puede crear un archivo nuevo para cada proyecto en particular. Para esto copiar el archivo por defecto y modificarlo a voluntad, luego se invoca en el comando.		# En el ejemplo anterior sobre el uso, se usa un archivo de configuración por defecto ubicado en el mismo directorio de DocStrap. Se puede usar el mismo archivo para todos los proyectos o se puede crear un archivo nuevo para cada proyecto en particular. Para esto copiar el archivo por defecto y modificarlo a voluntad, luego se invoca en el comando.

Felipe: /* Instalación */

2014-05-25T23:34:49Z

Instalación

← Older revision		Revision as of 23:34, 25 May 2014
Line 31:		Line 31:
	</li>		</li>
	<li>		<li>
	En vez de ejecutar cada vez estos comandos es mejor ponerlos en algún archivo que lo haga automáticamente. Esto se puede hacer en ~~diferentes partes, por ejemplo en~~ ~/.profile, ~~pero~~ una ~~mejor forma puede ser guardarlo~~ en el ~~archivo jsdoc~~ (~~mencionado en~~ el ~~[[Cómo documentar JavaScript#Instalación\|paso 4~~ de la ~~instalación de JSDoc]]), se agrega~~ el ~~código al principio del~~ archivo.		En vez de ejecutar cada vez estos comandos es mejor ponerlos en algún archivo que lo haga automáticamente. Esto se puede hacer en <code>~/.profile</code>, se agrega el código al archivo. Puede ser en otros archivos, lo importante es que sea uno que se ejecute cuando se inicie una sesión en el terminal (el archivo <code>~/.profile</code> solo se ejecuta cuando se ingrese al ''home'' de la persona donde está el archivo).
	</li>		</li>
	</ol>		</ol>

Felipe at 23:22, 25 May 2014

2014-05-25T23:22:33Z

← Older revision		Revision as of 23:22, 25 May 2014
Line 47:		Line 47:
	===Referencias===		===Referencias===
	* http://usejsdoc.org/, cómo usar JSDoc.		* http://usejsdoc.org/, cómo usar JSDoc.
			* http://terryweiss.github.io/docstrap/, DocStrap.

Felipe: /* DocStrap */

2014-05-25T23:21:48Z

DocStrap

← Older revision		Revision as of 23:21, 25 May 2014
Line 40:		Line 40:
	jsdoc js.js -t $JSDOC_DOCSTRAP_TEMPLATE_DIR -c $JSDOC_DOCSTRAP_CONFIG -d /directorio/donde/se/guarda/documentacion/		jsdoc js.js -t $JSDOC_DOCSTRAP_TEMPLATE_DIR -c $JSDOC_DOCSTRAP_CONFIG -d /directorio/donde/se/guarda/documentacion/
	</syntaxhighlight>		</syntaxhighlight>

			====Recomendaciones====
			# Se puede agregar el anterior comando en un archivo ejecutable para cada proyecto que requiera documentación de JavaScript. Se crea un archivo de Bash, se agrega la línea del comando a ejecutar y se cambia el output a la ubicación deseada.
			# En el ejemplo anterior sobre el uso, se usa un archivo de configuración por defecto ubicado en el mismo directorio de DocStrap. Se puede usar el mismo archivo para todos los proyectos o se puede crear un archivo nuevo para cada proyecto en particular. Para esto copiar el archivo por defecto y modificarlo a voluntad, luego se invoca en el comando.

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