Forma de usar Doxygen para escribir códigos fuente

Mantener el código fuente mantenible es uno de los retos más difíciles que enfrenta cualquier desarrollador de software, ya sea un programador lobo solitario o un miembro de un equipo grande. Doxygen le permite generar automáticamente a partir de la documentación C ++, Java, u otro código. Se analizará el código de indocumentado y escribir documentación básica, y se pueden añadir comentarios con formato especial a su código fuente para realizar adiciones útiles al código fuente generado.

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, puede hacer esto haciendo clic en el menú Inicio, seleccionando Ejecutar, entrando \ "cmd \", y haga clic en OK. En Mac OS, puede hacer clic en el menú Spotlight, el tipo de terminal, elija Terminal y cuando aparezca. Navegar por el símbolo del sistema en el directorio de código fuente escribiendo \ seguido del nombre del directorio "cd \" y pulsando Intro.

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 abriendo la Doxyfile en un editor de texto.

4 Añadir comentarios Doxygen a su código fuente. Doxygen comentarios son comentarios normales que contienen anotaciones especiales que permiten Doxygen para encontrarlos y que indican cómo debe utilizarlas. Por ejemplo, si usted está escribiendo en un lenguaje de estilo C, se puede añadir una breve descripción de una función mediante la adición del siguiente comentario antes de su declaración:

/! \ informar Mi breve descripción /
Puede ver todos los demás anotaciones Doxygen compatible con al stack.nl/~dimitri/doxygen/docblocks.html.

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