juanjonavarro.com

secciones

Javadoc no es sólo Javadoc

Nunca deja de sorprenderme lo bien que funciona y lo extensible que resultan muchas de las partes de Java. ¡Tendrá sus problemas pero es una buena pieza de ingeniería del software, desde luego! El caso concreto del que quiero hablar es la herramienta Javadoc.

Javadoc es la herramienta de java para generar documentación básica para el programador a partir del código fuente. Se intenta evitar que la documentación que se genera mediante un editor de texto se quede rápidamente obsoleta cuando el programa continúa su desarrollo y no se tiene la disciplina/tiempo para mantener la documentación al día. Para ello, se pide a los programadores de Java que escriban la documentación básica (clases, métodos, etc.) en el propio código fuente (en comentarios en el propio código), con la esperanza de que esos comentarios sí se mantengan actualizados cuando se cambia el código. La herramienta Javadoc extrae dichos comentarios y genera con ellos un juego de documentación en formato html.

Lo interesante de la herramienta (de ahí mi comentario sobre lo extensible de java) es que la transformación fuente->html la realiza utilizando un mecanismo extensible llamado doclet. Un doclet es una clase que es llamada por el programa javadoc para que genere la documentación. Existe un doclet por defecto que es llamado automáticamente por la herramienta (este es el que genera el html del que hablaba) pero se puede especificar otro doclet al ejecutar el javadoc.

La gente ha utilizado este mecanismo para las cosa más útiles que imaginarse uno pueda. Cosas como generar la documentación en otros formatos: RTF, PDF, XML. Pero también para cosas que no tienen que ver con la documentación, como generar informes sobre los cambios en el código entre versiones (JDiff), realizar programación por contrato (iDoclet) o cualquier cosa desde generar automáticamente las clases que componen un EJB hasta generar automáticamente el web.xml de un war mediante el potentísimo XDoclet. Estos y muchísimos más doclets se pueden encontrar en doclet.com

Todo esto viene a raíz de un proyecto que se me había ocurrido para hacer pero que finalmente no se si haré porque (como siempre) creo que alguien ya lo ha hecho. Información sobre mi idea y sobre si la haré o no (dependerá de si lo que he encontrado cumple o no mis expectativas) en una próxima entrada, cuando ya haya evaluado lo encontrado.

17 junio 2003 —
1 Comentarios
Jesus Gutierrez
Jesus Gutierrez
4 noviembre 2003, 22:00 — #1
He estado buscando informacion acerca de como utilizar el JavaDoc y no he encontrado mas que comentarios de lo que hace y no hace, en ultimas no se como emplearlo.
Podrias ayudarme con eso??
Gracias.

Comentarios cerrados para este artículo

Siguiente: Hace 105 años...