jueves, 17 de febrero de 2011

Documentación y herramientas



Documentación y herramientas - Clase

Hola que tal esta entrada trata acerca de la documentación y las herramientas que se pueden utilizar para documentar nuestros métodos clases de nuestro proyecto.

Bueno la idea de esta entrada es explicar el por que es bueno usar la documentación es bueno porque documentemos nuestro trabajo por que puede ser útil para otra persona o para nosotros mismo también es importante por que en un futuro nos puede servir de referencia para utilizarlas.

Bueno para todo esto existe Javadoc es una utilidad de Sun Microsystems para la generación de documentación de APIs en formato HTML a partir de código fuente Java. Javadoc es el estándar de la industria para documentar clases de Java. La mayoría de los IDEs los generan automáticamente.
Javadoc también proporciona una API para crear doclets y taglets, que le permite analizar la estructura de una aplicación Java. Así es como JDiff puede generar informes de lo que ha cambiado entre dos versiones de una API.

Bueno ya que mi aplicación la estoy desarrollando en Eclipse solo basta con ir ala pestaña "Project" y se mostrara un menu donde seleccionamos la opción de "Generate Javadoc" y después "finish" y es todo con esto hemos generado la documentación.


Para poder ver la documentación se guardan los archivos en la carpeta "doc" del workspace de Eclipse.

Links:


Un saludo a todos...

1 comentario: