Oscar's Blog

Blog de Oscar Valenzuela - GNU con Linux, Free Software, Android, Hacking

Documentación PHP autogenerada con PHPDocumentor

21 Aug 2013


Para aquelllos que nos encanta desarrollar cosas nuevas, siempre es una molestia necesaria el documentar el software adecuadamente, seguir un estandar o simplemente colocar esos comentarios que permitirán a quienes usen nuestros códigos saber que diablos hace cada cosa.

Si te identificas con esta descripción, entonces encontrarás el siguiente post más que interesante, puesto que te da la oportunidad de preocuparte y hacer lo que te gusta, sin alejarte de contar con documentación al más puro estilo profesional, para esto usamos la herramienta PHPDocumentor. A continuación entonces va un ejemplo de uso de esta espectacular herramienta.

Lo primero, será bajar e instalar las herramientas necesarias, puesto que usaremos la versión de PHPDocumentor que aún esta en desarrollo, puesto que esta versión trae un template mucho más bonito y nuevas funcionalidades.

Fedora:

yum install graphviz-php php-xml pear

Trisquel:

apt-get install php-pear php-xml-parser libgv-php5 php5-xsl graphviz

Una vez descargadas las librerías, procederemos a descargar y compilar las herramientas usando pear:

pear channel-discover pear.phpdoc.org

pear install phpdoc/phpDocumentor-alpha

Con esto, ya dispondremos del comando phpdoc en nuestro sistema, y como la documentación de PHPDocumentor es muy buena, solo incluiré un ejemplo de uso:

phpdoc -d Libs/ -d Schedules/ -t Docs/PHPDoc/

En el ejemplo anterior, pedimos a phpdoc que revise los directorios Libs y Schedules por clases y que la salida de la documentación se exporte en el directorio Docs/PHPDoc/. Lo mejor de todo es que si en algún lugar tenias algún error en tus comentarios, entonces el sistema te lo señala al momento de generar la documentación!, simplemente espectacular!

A continuación unas fotos de como queda:

Captura de pantalla de 2013-08-21 14:15:53

Captura de pantalla de 2013-08-21 14:15:24

Captura de pantalla de 2013-08-21 14:15:13

Realmente espectacular, y si quieren hechar un vistazo a como funciona en vivo, les invito a ver la documentación de las clases principales de WarpIT! Directamente aquí:

http://www.xpertians.com/warpit/Docs/PHPDoc/packages/WarpIT!.html