JSdoc - Documenta Tu Código de Javascript

JSDoc es un herramienta que analiza el código de tus archivos Javascript y te genera la documentación en formato HTML, XML o XMI (UML). JSDoc esta basada en el conocido Javadoc que hace lo mismo para el lenguaje de programación Java.

Cualquiera que este familiarizado con Javadoc podrá usar JSDoc ya que la manera de documentar nuestro código es la misma,poniendo nuestros comentarios entre /** y */.

JSDoc esta desarrollado en Perl lo que requiere que tengamos instalado el Perl en nuestra computadora.

Un ejemplo de código de Javascript documentado sería el siguiente:

/**
* Shape is an abstract base class. It is defined simply
* to have something to inherit from for geometric
* subclasses
* @constructor
*/
function Shape(color){
this.color = color;
}
// Bind the Shape_getColor method to the Shape class
Shape.prototype.getColor = Shape_getColor;
/**
* Get the name of the color for this shape
* @returns A color string for this shape
*/
function Shape_getColor(){
return this.color;
}
/**
* Circle is a subclass of Shape
*/
function Circle(radius){
this.radius = radius;
}
/**
* A very rough value for pi
*/
Circle.PI = 3.14;
/**
* Get the radius of this circle
* @returns The radius of this circle
*/
function Circle_getRadius(){
return this.radius;
}
// Circle is a subclass of Shape
Circle.prototype = new Shape(null);

Para su uso simplemente se teclea en linea de comandos la siguiente instrucción:

> Perl jsdoc.pl archivo.js

[Descargar JSDoc]

Mas Información�

Via: SentidoWeb

Otros Enlaces Relacionados:

¿Te pareció interesante la nota?, registrate a nuestro Feed para que estes al dia con las últimas notas que publicamos en WebAdictos, tambien te invitamos a explorar nuestros archivos tal vez encuentres notas y recursos que te sean de utilidad.

Si lo prefieres puedes utilizar el botón de post aleatorio para ir saltando entre nuestros contenidos.
Gracias por visitarnos.