JSDoc: documentar javascript

Blogs Media: CSS Mania | VivirLatino | Sentido Web | Apps Mania

Jue05Jul2007

JSDoc: documentar javascript

JSDoc es una aplicación realizada en Perl que nos genera la documentación de nuestros scripts Javascript de forma automática. Basado en el conocido javadoc, obtiene los comentarios de documentación (/** ... */) para obtener la información sobre las funciones.

Así, por ejemplo, si tenemos la siguiente función:

/**
* Figura es una clase abstracta. Define
* lo que otras subclases heredarán de una 
* figura geométrica genérica
* @constructor
*/
function Figura(color){
  this.color = color;
}

obtendremos lo siguiente:

Constructor Summary
Shape ()
     Construct a new Shape object.

JSDoc

Vía / Blogging Dashin

Relacionados

TrimQuery: usa SQL en Javascript (Miércoles, 04 Jul 2007)
XRegExp: ampliación de expresiones regulares en Javascript (Jueves, 21 Jun 2007)

Luis Sacristán

Abrir conversación | Del.icio.us

Sin comentar » Formulario

Participa | Navega con Firefox u Ópera

— Publicidad —

WHOIS!

Sentido Web es la publicación creada por Blogs Media dirigida a los desarrolladores web e internautas apasionados por la programación, diseño, negocios y todo lo que ocurre en Internet. La revista que siempre has querido leer y sin ir al kiosko.

About | Uso | Anúnciate