Doxygen es un programa de Dimitri van Heesch con licencia GLP que te permite la creación de documentación a partir del código fuente de un programa. Para esto, Doxygen utiliza la gramática del lenguaje en que esté escrito el código, así como los comentarios en un formato particular. Los formatos que soporta son: C, C++, Java, Objective C, Python, IDL y, en algunos casos, PHP, C# y D. Por otro lado, la documentación puede generarse en HTML, LaTeX, RTF, PDF y XML.
El principal interés de Doxygen es permitir la integración de la documentación directamente en el código fuente, favoreciendo así la coherencia entre ambos. Este software también posibilita extraer documentación a partir de un código fuente no documentado de antemano, lo que facilitará la compresión de un programa generado por este código.
Parte de la información que puede extraerse del código fuente es:
- Prototipo y documentación de las funciones, ya sean locales, privadas o públicas,
- Lista de archivos incluidos.
-Documentación de las estructuras de datos.
- Prototipo y documentación de las clases y su jerarquía.
- Diferentes tipos de gráficas: diagramas de clase, de colaboración, de llamadas, etc…
- El índice de todos los identificadores.
Ideal para desarrolladores, puedes descargar aquí este programa y ahorrarte las horas más soporíferas (que yo lo sé) de tu trabajo.
Añadir a Del.Icio.Us
Comentarios de “Doxygen documenta el código por ti”
Aun no se han realizado comentarios.