Sistema de documentación para C++, IDL, y C
Doxygen es un sistema de documentación para C++, IDL (Corba, Microsoft, y KDE-2 DCOP) y C.
Doxygen genera un navegador de documentación on-line (en HTML) y/o un manual de referencia off-line para un conjunto de documentos de ficheros fuente. Además soporta la generación de ficheros RTF (MS-Word), Postscript, PDF, HTML comprimido, y Unix. La documentación se extrae directamente de los ficheros fuente, lo que hace que sea más fácil mantener la información consistente en el código fuente.
Puede ser configurado para extraer la estructura del código de ficheros fuente indocumentados. También se puede usarse para crear documentos de texto normales.
Opinión usuarios sobre Doxygen
por Anonimo
Doxigen.
La verdad es que doxigen es muy potente para documentar tu código. Además si lo usas junto con herramientas como dot puedes acabar teneiendo una documentación perfecta para que cualquiera pueda iniciarse en cualquier proyecto con una linea de aprendizaje mucho más suave.
Cons:
Tiene pequeños bugs, pero no funcionales. Más
por Anonimo
Excelente y recomendable.
Excelente programa, especialmente si se lo usa en forma conjunta con la utilidad dot para generar automáticamente gráficos de dependencias, estructuras, etc. Muy configurable, y excelente presentación de la documentación de salida. Recomendable.
Pros:
La posibilidad de incluir gráficos de dot, simplemente indicando el path hacia el ejecutable dot.exe. Permite también incluir graficos en formato jpg. La documentación está siempre actualizada, ya que es generada automáticamente a partir del código fuente al que se agregan determinadas tags dentro de los comentarios. El programa puede dejarse abierto mientras se codifica, e ir actualizando la documentación y observando la salida tras cada cambio en el código fuente.
Cons:
La interfase de usuario (doxywizard) todavía es rudimentaria, aunque en las últimas versiones ha ido mejorando mucho con el agregado de tips en cada campo. Hay varios bugs, y a veces la interfase se cierra inesperadamente. También es necesario mejorar el aspecto y ciertas características de doxywizard. Estas desventajas son ínfimas si se las enfrenta con las excelentes características de la documentación generada. Más