Doxygen para nuestros proyectos

Durante mucho tiempo he usado la herramienta javadoc para generar la documentación de código fuente escrito en JAVA (API, librerías, etc.). Además, su integración con Maven es buena gracias al plugin correspondiente.

Hace algunos años usé Doxygen para generar la documentación de una demo y me gustó mucho, sin embargo no trasladé su uso al resto de mis proyectos. Hace unos días surgió la necesidad de seleccionar una herramienta para generar la documentación de nuestro código fuente. Las premisas eran:

  • Una única herramienta para todos los proyectos: En nuestro caso esto no supuso un problema porque nuestro marco tecnológico está definido y trabajamos con Java, Python, PHP y Perl.
  • Formatos de salida usables: HTML es un buen formato porque está muy extendido y es fácil disponer de un ordenador con navegador web para procesarlo.
  • No queríamos perder la integración con Maven (Maven sites).

La elección ha sido Doxygen y los motivos han sido:

  • Nos permite documentar nuestro código Java, Python, PHP y Perl.
  • Existen versiones para GNU/Linux, Windows y MacOSX
  • Formatos de salida (que he probado): HTML (más atractivo y usable que el generado por javadoc) y PDF.
  • Y para la integración con Maven existe un plugin. Muy importante para nosotros para poder añadir a nuestros procesos de integración continúa la generación de este tipo de documentación.

Podéis ver un ejemplo en la documentación de Opina.

One thought on “Doxygen para nuestros proyectos

  1. Pingback: Mi espacio» Blog Archive » Configurando el plugin de maven para Doxygen

Leave a Reply

Your email address will not be published. Required fields are marked *