Least Significant Bit

All in all we’re just another bit in the word

Documenta tu código con Doxygen

Posted by jayzeegp en julio 12, 2008

Doxygen es un sistema de documentación de código para C, C++, PHP, Java y algunos lenguajes más. Funciona bajo Linux y (según la página) también bajo MAC OS X. Yo siempre lo he utilizado bajo Linux y usando C o C++.

Se instala con un simple:

sudo apt-get install doxygen

Una vez instalado, simplemente tienes que cumplir ciertas especificaciones (que vienen explicadas perfectamente en la página) a la hora de documentar el código.

Posteriormente, hay que generar el fichero de configuración en el que diremos cómo queremos que se documente el código y podremos cambiar diferentes parámetros, así como decidir en qué tipo de fichero queremos que nos genera la documentación (soporta salida en HTML, XML, RTF y LaTeX).

Para generar un fichero de configuración ejecutamos lo siguiente:

doxyfile -g <nombre-fichero>

Luego deberíamos abrir ese fichero con un editor de texto para poner los parámetros como nos interesen (vean la página de doxygen para más información).

Por último ejecutamos doxygen:

doxygen <nombre-fichero>

Se generará la documentación en los formatos de salida que hayamos indicado.

También se puede instalar doxygen-gui que como su nombre indica es una interfaz gráfica de usuario para utilizarlo, la verdad es que no la he probado porque me va bastante bien con lo explicado antes.

Un saludo;)

Responder

Por favor, inicia sesión con uno de estos métodos para publicar tu comentario:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s

 
A %d blogueros les gusta esto: