Knowledge Base

¿Qué es esto?

PHP: Uso general de php documentor

12/01/2016 - 27/12/2018 -  Comentarios - PHP PHP documentor

Primero hay que instalar documentor en el proyecto. Usando composer los pasos son los siguientes:

1) Añadir al fichero composer.json la información siguiente:

{

    "require-dev": {

        "phpdocumentor/phpdocumentor": "2.*"

    }

}

2) Abrimos una consola y hacemos el update de la aplicación (tenemos que ejecutarlo en el directorio raíz de la aplicación y con composer instalado en ese proyecto):

php composer.phar update (ejecutar php composer.phar install si no se ha instalado ninguna dependencia antes)

Una vez lo tenemos instalado podemos generar la documentación del proyecto. Para ello habría que ejecutar este comando:

/var/www/html/project_folder/vendor/bin/phpdoc -d ./ --ignore vendor/ --template="responsive-twig"

Dónde:

- /var/www/html/project_folder/vendor/bin/phpdoc -> es el ejecutable de phpdocumentor. Normalmente estará dentro de vendor/bin siempre que se haya instalado con composer

- -d ./ -> especificamos el directorio que hay que documentar

- --ignore vendor/ -> especificamos los ficheros o directorios que habría que ignorar

- --template="responsive-twig" -> Indicamos el tema con el que queremos generar la documentación. Los templates disponibles son los siguientes: http://www.phpdoc.org/templates .  Es posible especificarle más de un tema a la vez de la siguiente manera: --template="checkstyle,clean". También podemos generar templates propios, está explicado aquí: http://phpdoc.org/docs/latest/getting-started/changing-the-look-and-feel.html#creating-your-own-look-and-feel