Instalación e uso de phpDocumentor

Consideracións pedagóxicas

Este material pode ser utilizado:

• No módulo Despregue de Aplicacións Web do Ciclo de Desenvolvemento de Aplicacións web
  • No "BC6. Documentación das aplicacións web e sistemas de control de versión"
    • Ferramentas externas para a xeración de documentación: instalación, configuración e uso
    • Formatos estándar para a documentación. Uso de linguaxes de marcas na documentación de aplicacións web.
• No módulo Contornos de Desenvolvemento do Ciclo de Desenvolvemento de Aplicacións web

Considerecións previas

• É convinte un coñecemento básico de programación e a linguaxe PHP

Instalación

Instalación usando Phibe

$ phive install phpDocumentor

Descargando el PHAR

Descargando la última versión ou unha específica
Invocando PHP co ficheiro phar como parámetro:
$ php phpDocumentor.phar -d . -t docs/api

Para Mac e Linux, previamente:

Marcar o ficheiro como executable 
$ chmod +x phpDocumentor.phar
Movelo a ruta do cartafol bin
$ mv phpDocumentor.phar /usr/local/bin/phpDocumentor
 

Instalación con docker

Se tes docker instalado:

$ docker run --rm -v $(pwd):/data phpdoc/phpdoc:3

Usando docker

• Documentación oficial de Instalación de phpDocumentor

Uso

• Exemplo de uso de phpDocumentor

Posible tarefa

1. Instala a ferramenta seguindo a documentación oficial (ou calquera outra que te sirva de axuda).
2. Documenta unha función a que se lle pasa dous valores e devolve a suma dos mesmos:
3. Entrega un documento explicando para qué sirve phpDocumentor, e os pasos seguidos na instalación e xeración de documentación,
4. Amosa captura de pantalla do resultado obtido.