Mantener el código fuente es fácil de mantener uno de los retos más difíciles que enfrenta cualquier desarrollador de software, si un lobo solitario programador o un miembro de un equipo grande. Doxygen permite generar automáticamente la documentación de C + + , Java, u otro código . Se analizará el código de indocumentados y escribir documentación básica , y se puede agregar comentarios con formato especial en el código fuente para hacer adiciones útiles para el código fuente generado . Cosas que necesitará
código fuente
Editor de texto
Mostrar más instrucciones
1

Descargar e instalar Doxygen . Está disponible en stack.nl /~ dimitri /doxygen /download.html # latestsrc .
2

Abra un símbolo del sistema . En Windows XP usted puede hacer esto haciendo clic en el menú Inicio , seleccionar Ejecutar, escribe " cmd" y haga clic en Aceptar. En Mac OS , puede hacer clic en el menú de Spotlight , el tipo de terminal , elija Terminal y cuando aparezca. Navegar por el símbolo del sistema para el directorio del código fuente , escriba " cd " seguido del nombre del directorio y pulsando Enter.
3

Crear un Doxyfile escribiendo " doxygen -g " y pulsando Intro. Esto generará un archivo en el directorio actual llamado " Doxyfile ", que contendrá todas las opciones por defecto Doxygen . Puede modificar estas opciones , abra el Doxyfile en un editor de texto.
4

Agregar comentarios Doxygen a su código fuente. Doxygen comentarios son comentarios habituales que contienen anotaciones especiales que permiten Doxygen encontrarlos e indicar cómo debe utilizarlas. Por ejemplo , si usted está escribiendo en un lenguaje de tipo C , se puede añadir una breve descripción de una función , añadiendo el siguiente comentario antes de su declaración :/*! \\ breve Mi breve descripción * /Se puede ver toda la otra Doxygen anotaciones compatible con al stack.nl /~ dimitri /doxygen /docblocks.html .
5

Type " doxygen Doxyfile " en el símbolo del sistema y pulse Intro. Esto generará la documentación de su código fuente.