Instalando phpDocumentor

Para hacer más sencilla la labor de documentación del código generado, me propongo probar la herramienta phpDocumentor.

Instalación

Dependencias

Antes de instalar la herramienta phpDocumentor, hay que satisfacer una serie de dependencias.

  1. Extensión XSL.
    $sudo apt-get install php5-xsl
  2. Extensión INTL.
    $sudo apt-get install php5-intl
  3. Herramienta GIT.
    $sudo apt-get install git

Una vez satisfechas las dependencias, ya puede instalarse la herramienta.

Instalación manual de phpDocumentor

Tal y como se explica en https://github.com/phpDocumentor/phpDocumentor2, hay que descargar el installer desde https://raw.github.com/phpDocumentor/phpDocumentor2/develop/installer.php, y guardarlo en una carpeta local, <phpdoc_path>.

Una vez descargado, desde la carpeta <phpdoc_path> donde se guardo el instalador, ejecutar:

$php installer.php

Uso de phpDocumentor

Para generar la documentación de un código almacenado en la carpeta <source> y guardar esa documentación en la carpeta <target>, basta con ejecutar:

$php /phpdoc.php -d  -t 
Ejemplo de documentación generado con phpDocumentor.

Ejemplo de documentación generado con phpDocumentor.

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *