JSdoc - Documenta Tu Código de Javascript
Friday, Julio 6th, 2007JSDoc 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
Via: SentidoWeb
