Documentación similar a Javadoc para C++

Question

¿Hay sistemas de generación de documentación similares a Javadoc para C++? Javadoc produce buenos resultados; Sería genial si pudieras usar algo similar en otros idiomas.

Answer 1

Hay varias herramientas que funciona como JavaDoc para C++ La herramienta más popular es probablemente Doxygen. Puede manejar comentarios similares a JavaDoc, y también varios lenguajes (por ejemplo, C++, C, Java, Objective-C, Python, PHP, C#). Tiene un soporte bastante bueno para ajustar el estilo de la salida HTML usando CSS (ver el users list por ejemplo documentaciones).

Dos cuestiones importantes a la hora de elegir el sistema de documentación es para asegurarse de que le permite

• Documento de las entidades que le interesan. ¿Desea documentar el sistema siguiendo la estructura del código o según alguna otra división de módulos.
• Obteniendo la salida formateada como lo desee. Es preferible cuando la documentación se ajusta al estilo general de su proyecto.

Nuestra experiencia con doxygen es que es bastante fácil de configurar y usar, y la salida resultante es bastante fácil de ajustar. Desafortunadamente, doxygen no es perfecto, por lo que en algunos casos es necesario evitar las peculiaridades o errores en los que se descompone el analizador doxygen. Asegúrese de inspeccionar cuidadosamente toda su documentación generada.

Answer 2

Hay Doxygen

Answer 3

No se puede usar javadoc específicamente, pero hay un par de herramientas que hagan lo que quieran. La que la mayoría de la gente tiende a usar es Doxygen. Aquí hay algunos enlaces para Doxygen y DoC++:

Doxygen
Doc++

Answer 4

También hay qdoc para proyectos basados ​​en QT en C++. http://doc-snapshot.qt-project.org/qdoc

Answer 5

Estoy empezando a usar Sphinx para mis proyectos de Python. Su página de inicio indica "C/C++ también es compatible".

Utiliza un marcado ligero llamado "reStructuredText".

Acabo de empezar a usarlo para mis proyectos de Python, y me gusta mucho el aspecto de la salida.