Instalación phpDocumentor debe ser fácil. Al menos, He leído aquí y allá en Internet, además por supuesto en el sitio web oficial, que usted tiene muchas opciones para instalarlo, uno más fácil del anterior!
Así que estaba absolutamente seguro de que en un montón de minutos habría sido capaz de ejecutar phpDocumentor y crear la documentación para mi nueva clase de Php.
Tú sabes? estaba equivocado. Esto es lo que pasó.
phpDocumentor.phar
Lo primero que probé ha sido usar el archivo .phar. Sé que la primera forma que sugieren es usar PEAR, pero tuve una experiencia positiva sobre el uso de archivos .phar un día antes: Quería tener php-cs-fixer configurado y ejecutándose en Atom y después de varios intentos terminé usando el archivo php-cs-fixer.phar. Entonces, cuando llegó el momento de instalar phpDocumentor me dije: & quot; ¿Por qué debería tener que luchar con la línea de comandos?, problemas de dependencias y el resto cuando puedo descargar un solo, maravilloso archivo y ponerlo en mi directorio php?" Hecho! Una vez que tuve phpDocumentor.phar instalado, Abrí el símbolo del sistema directamente en la carpeta de mi clase y escribí
phpdoc -d "." -t "./Docs"
BUUUZZZZ!!!
No se pudo abrir el archivo de entrada: «phpDocumentor.phar»
Instalación de phpDocumentor con Composer
Wooops, Qué es esto? Empecé a buscar en Google un poco, pero sin éxito, así que abandoné tristemente el archivo .phar y seguí con Composer. peor que antes!
phpdoc no se reconoce como un comando interno o externo
A Google o no a Google? No, No quiero perder el tiempo para entender por qué algo que se dice que funcione no funciona (sin hablar de Composer en sí, que es una gran herramienta que utilizo en varias ocasiones, solo hablando de instalar phpDocumentor a través de Composer). Intento archivado.
Instalación de phpDocumentor con PEAR
Siempre tuve una buena experiencia instalando extensiones php a través de PEAR, así que pensé que habría funcionado incluso instalando phpDocumentor. Escribí el siguiente comando y esperé ansiosamente la respuesta:
pear channel-descubre pear.phpdoc.org pear instalar phpdoc / phpDocumentor
Guau, todo parecía ir bien! Una vez finalizado el proceso, He hecho otro intento de crear mi documentación escribiendo el comando habitual:
phpdoc -d "." -t "./Docs"
Aaarrghhh!!! La ventana del símbolo del sistema se ha llenado con muchas advertencias y errores relacionados con las plantillas de Smarty!
La solución
Te ahorraré los detalles. Solo digo que treinta / cuarenta minutos de googlear me dieron la solución: descargando la versión 2.9.0 directamente desde Github. fui a https://github.com/phpDocumentor/phpDocumentor2/releases/tag/v2.9.0 y haga clic en el archivo comprimido con el nombre phpDocumentor-2.9.0.tgz para descargarlo y… No me preguntes por qué, tal vez ese dia tuve terriblemente mala suerte, pero la descarga fue terriblemente lenta, se detuvo varias veces y una vez que se ha completado, el archivo estaba dañado!
La verdadera solucion!
Afortunadamente he encontrado otro sitio web que permite descargar ese archivo: https://fossies.org/linux/www/phpDocumentor-2.9.0.tgz/. Finalmente, Tengo el archivo. Lo puse en una carpeta temporal, abrió el símbolo del sistema y simplemente escribió:
pear instalar phpDocumentor-2.9.0.tgz
Aún falta un pequeño ajuste en el archivo phpdoc.bat. Vaya a su carpeta php (En mi Windows 10 partición he instalado xampp, entonces mi php se encuentra en C:\carpeta xampp php) y abra phpdoc.bat con un editor de texto. Debe tener un aspecto como este:
@echo apagado Si "%PHPBIN%" == "" establecer PHPBIN = php.exe si no existe "%PHPBIN%" Si "%PHP_PEAR_PHP_BIN%" neq "" ir a USE_PEAR_PATH IR A CORRER :USE_PEAR_PATH establecer PHPBIN =% PHP_PEAR_PHP_BIN% :CORRER "%PHPBIN%" "%PHP_PEAR_BIN_DIR% phpdoc" %*
Simplemente cambie la última línea reemplazando "%PHP_PEAR_BIN_DIR%\phpdoc" con la ruta completa a su archivo phpdoc. En mi caso, el archivo phpdoc.bat resultante se ve así:
@echo apagado Si "%PHPBIN%" == "" establecer PHPBIN = php.exe si no existe "%PHPBIN%" Si "%PHP_PEAR_PHP_BIN%" neq "" ir a USE_PEAR_PATH IR A CORRER :USE_PEAR_PATH establecer PHPBIN =% PHP_PEAR_PHP_BIN% :CORRER "%PHPBIN%" "C:\xampp php phpdoc" %*
Eso es todo, ahora funciona! Y tengo mi documentación completa con mi plantilla favorita:
phpdoc -d "." -t "./Docs" --plantilla ="ramita sensible"
Si te ha resultado útil este artículo, por favor compártelo a través de tus redes sociales. Si quieres dejarme un comentario, Estaré encantado de saber de ti!