Documentar es algo que a ningún informático (o profesional de la informática, mejor dicho, me da igual lo que haya estudiado) se nos da especialmente bien, eso lo deberíamos tener todos bastante claro. Es por ello que el disponer de algunas herramientas para ayudarnos a realizar esta tarea nos pueden salvar la vida (que dramático!). Hoy os presentamos una: UMLGraph.

Para los que no lo conocéis, UMLGraph es un doclet para añadir a javadoc capaz de dibujar gráficos UML a partir de nuestro código. Podemos sacar todos los objetos de nuestro proyecto, dividirlo por paquetes o clases de interés, dibujar relaciones de distintos tipos e incluso jugar con diagramas de actividad.

En nuestro código tenemos que añadir… prácticamente nada. Hay dos cosas que tenemos que hacer, aunque son opcionales, simplemente si queremos obtener un diagrama más limpio o atractivo. 1.- algún tag por javadoc, en especial los que se refiere a las relaciones de composición. 2.- una clase que defina nuestro gráfico: clases a incluir o no incluir, colores, etc.

La instalación en MacOSX no fue especialmente fácil (toco recompilar por tener un path a una fuente “a pelo”), pero aún así merece la pena, y su integración con Ant: indolora.

Modelo de ejemplo