c++ - org - linux doxygen

¿Es Sphinx ya adecuado para la documentación en C++?

Question

Quiero probar los generadores de documentación para un nuevo proyecto en C ++. Creo que mis opciones son Doxygen o Sphinx. Como tengo proyectos en Python para los cuales me gustaría usar Sphinx, me pregunto si Sphinx es la opción correcta para C ++ también. El sitio web de Sphinx indica que C ++ es compatible, pero no pude encontrar un documento que me permitiera comenzar con la documentación de C ++.

Una pregunta similar ya ha sido discutida en Stackoverflow y la respuesta principal concluye:

aún no completamente utilizable,
pero sigue mirando

Dado que la discusión tiene más de un año , me pregunto si esta conclusión aún es válida. ¿Debo elegir Doxygen sobre Sphinx para mi documentación en C ++?

Answer 1

Para C ++ Doxygen es muy bueno; El soporte de Sphinx de C ++ se realiza a través de Doxygen (usando Breathe ).

Desea tener solo una herramienta para los dos idiomas, para mejorar el mantenimiento. Doxygen puede generar una documentación del código de Python , por lo que le aconsejo que use Doxygen para ambas fuentes, si es posible. Aquí hay un tutorial para Doxygen y Python .

Answer 2

Sphinx no puede extraer documentación de fuentes C ++ en sí mismo. Sin embargo, hay extensiones, especialmente Breathe , que utilizan Doxygen para extraer documentación de C ++. No he probado ninguno de estos.