Mamedu
Últimas entradas en Documentar código
Añadir un grupo nuevo: ## @defgroup libash Librerías para bash## @{.....## @} Todo el código entre las llaves sera mostrado dentro de la sección de módulos Tambíen podemos añadir a un grupo existente: ## @file configuracion#### @brief Librería para gestionar la configuración de los scripts de bash#### Para trabajar con esta librería es necesario que tengamos un archivo de configuración definido,## y sus variables de
Truco para poder tener una buena documentación de nuestros scripts con doxygen Doxygen tiene la capacidad de hacer un filtrado antes de procesar los archivos, para activarlo creamos un script en bash que debe contener lo siguiente: cat "$1" | sed 's/##<////</g' | sed 's/##/////g' | sed '////|^$/!s/$/;/' En la configuración de doxygen añadimos los siguientes cambios: INPUT_FILTER = "../../proyectos/mytrabajos/magdoxygen --filtra bash"FILTER_SOU
Doxygen ademas de documentar el código, nos permite una manera de crear documentación extra en archivos separados del código. Ejemplo: Generamos archivos readme.dox para generar un manual de la aplicación. @page manual Manual@section lanzadores Lanzadores al inicioSi encontramos "$HOME/.magtrabajos/$proyecto/lanzadores" el archivo lo añadimosal iniciar el programa. Para automatizar el lanzamiento de aplicaciones que abrimosal trabajar en el proyecto.Ejemplos
Documentación de código Para que doxygen tenga en cuenta los comentarios deben tener el siguiente formato:   /** Comienza bloque comentado */ Termina bloque /// comentario de una linea ///< Despues del elemento Etiquetas generales: Las etiquetas iran precedidas de '@' o '' file todo author param return version see tables para indicar las tablas que se utilizan de mysql deprecated brief bug code example Etiquetas de formato: c f..
Otro programa que se complementa bien con doxygen utilizan las mismas reglas para la documentación referencia todas las variables y tambien las tablas...

Usuario:

Contraseña:


ojo.gif
www.mamedu.com
Webmaster