miércoles, 16 de febrero de 2011

Documentación y herramientas de desarrollo

La documentación de un código es una forma de mantener legible éste mediante etiquetas. Ademas podemos continuar  con el trabajo sin tener que revisar a fondo el codigo, muy util si se trata de un trabajo muy largo. Independientemente del lenguaje en que trabajamos, la documentacion es necesaria y esta disponible para todos los lenguajes conocidos.

Para generar la documentación en Java es necesaria la herramienta llamada "javadoc", incluida en el JDK, que nos generará un .html de las etiquetas dentro del código.

Éstas etiquetas son:

/**
 *Descripcion de la clase
 */
public class clase{
}

Donde lo que va entre /** y */ es la descripción de la clase.

Tambien existen tags para agregar información de variables, autor, versión, etc.

@author Donde se coloca el nombre del desarrollador.

@deprecated Indica que un método o clase es antigua y no se reco mienda su uso.

@param Es la definición de un parametro de un método.

@return Informa lo que devuelve el método.

@see Asocia con otro método o clase.

@throws Excepción lanzada por el método.

@version Versión del método o clase.

Con Eclipse podemos generar la documentación de la siguiente manera:

Abrimos el menú "Project" y damos clic en "Generate Javadoc..."

Se abrirá una ventana como la iguiente:


Tildeamos la carpeta de nuestro proyecto y elegimos "private" para que genere documentación de todas las clases. Damos clic en finish.

Por ultimo nos genera una serie de documentos .html que es la documentación de nuestro proyecto.

1 comentarios:

Elisa dijo...

Bien; hubiera sido bueno mostrar dónde se lo generó el HTML y cómo verlo, para gente menos hábil ;) Te pongo 5.

Publicar un comentario