:: Doxygen. Generador de documentación

Existen multitud de herramientas para documentar el código fuente, pero hoy describiremos brevemente una de ellas, utilizada ampliamente y con una reducida curva de aprendizaje.

Según la definición que figura en la Wikipedia, Doxygen es un generador de documentación para C++, C, Java, Objective-C, Python, IDL (versiones Corba y Microsoft), VHDL, PHP, C# y D.
Dado que es fácilmente adaptable, funciona en la mayoría de sistemas Unix así como en Windows y Mac OS X. La mayor parte del código de Doxygen está escrita por Dimitri van Heesch.


Un ejemplo de comentarios para documentar una clase:

/**
 * @class DBConnection
 * @author Nombre de empresa o autor
 * @version 1.0
 * @date 2015-11-13
 * @brief Clase para crear conexiones a la base de datos basandose perfiles que encapsula
 * a la clase PDO de PHP.
 * @file   DBConnection.php
 * @todo Tareas pendientes a realizar
 * - Primera cosa pendiente
 * - Segunda cosa pendiente
 * - Tercera cosa pendiente
 */
/**
 * Esta clase establece las conexiones a la base de datos basándose en perfiles que encapsula
 * a la clase PDO de PHP.
 * Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet ,
 * Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet ,
 * Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet
 * Lorem ipsum dolor sit amet .
 * Lorem ipsum dolor sit amet .
 */ 

Una vez configurado doxygen con la ubicación del código fuente y la carpeta en la que almacenará la salida (en el formato seleccionado), recorrerá los ficheros buscando las directivas correspondientes (@class, @author, @version,....) generando la documentación.
Su uso es muy sencillo y una vez comentado nuestro código fuente, la herramienta nos facilitará la generación de la documentación en un formato que nos permitirá su consulta de una forma ágil.

Información y descarga: http://www.stack.nl/~dimitri/doxygen/