para metodos herramientas fuente documentar documentacion como codigo java c++ javadoc

java - metodos - herramientas para documentar codigo fuente



Documentación similar a Javadoc para C++ (5)

¿Existen sistemas similares de generación de documentación como Javadoc, para C ++? Javadoc produce buena salida; Sería genial si pudieras usar algo así en otros idiomas.

Estoy empezando a usar Sphinx para mis proyectos de Python. Su página de inicio dice "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.

Existen varias herramientas que funcionan como JavaDoc para C ++. La herramienta más popular es probablemente Doxygen . Puede manejar comentarios similares a JavaDoc y también varios idiomas (por ejemplo, C ++, C, Java, Objective-C, Python, PHP, C #). Tiene un soporte bastante bueno para ajustar el estilo de la salida HTML mediante CSS (consulte la lista de usuarios para ver ejemplos de documentación).

Dos cuestiones importantes al elegir el sistema de documentación es asegurarse de que le permita

  • Documente las entidades en las que está interesado. ¿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 quieras. Es preferible que la documentación coincida con su estilo de proyecto general.

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, el doxygen no es perfecto, por lo que en algunos casos es necesario solucionar algunos problemas o errores en los que el analizador de doxygen se rompe. Asegúrese de inspeccionar cuidadosamente toda la documentación generada.

No puedes usar javadoc específicamente, pero hay un par de herramientas que hacen lo que quieres. El que la mayoría de la gente tiende a usar es Doxygen. Aquí hay algunos enlaces para Doxygen y Doc ++:

Doxygen
Doc++