jump to navigation

Documentar el codigo JavaScript febrero 14, 2007

Posted by superpiwi in Javascript.
trackback

Si necesitas documentar el codigo JavaScript puedes emplear JSDoc.

http://jsdoc.sourceforge.net/

Es una herramienta muy sencilla (eso si, necesitas tener un interprete de perl instalado en la maquina). Para documentar la sintaxis es:

perl jsdoc.pl <tufichero.js>

Ejemplo para el fichero “util.js” con este contenido:


/**
* @fileoverview Libreria con funciones de utilidad
*
* @author jose
* @version 0.1
*/
/**
* Muestra un mensaje de texto
* @param {String} metodo nombre del metodo
* @param {String} mensaje mensaje a mostrar
* @returns {integer} el codigo de retorno 0
*/
function trazas(metodo,mensaje)
{
alert("["+metodo+"]:"+mensaje);
return 0;
}
//--------

Al ejecutar:

perl jsdoc.pl util.js

se generan una serie de ficheros HTML en el directorio con la documentacion de la libreria javascript. El resultado es muy vistoso:

jsdoc.jpg

Comentarios»

1. Juan - agosto 30, 2012

esta chevere

2. Patrick - julio 22, 2013

I really treasured your webpage as well as , points.
That you will be tremendous.
Thank you intended for providing this valuable so aspire to create in addition of
the stuff in the coming years.
Phenomenal give good results retaining yuor web blog wash and therefore
high-quality without the need of nearly any junk mail.

Do you realy get any ideas when it comes to my very
own web page to stay them free of fakes?
And also any possibilities regarding how to yield using fabulous prime quality
similar to that of you?
I’m sorry in my language🙂 it is often never ever all of my natural code, high hopes it is easier to are aware of

3. realestateinbelize - octubre 17, 2013

super! i’m so glad that if found your cool page I will be marking
this for later! – real estate band is an interest of mine and and
your “Documentar el codigo JavaScript | Java.Lang.NullPointer”
article is without doubt great work.
great stuff, I’ll check back again real soon!


Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s

A %d blogueros les gusta esto: