Ir al contenido principal

Entradas

Mostrando las entradas con la etiqueta PHPDoc

DocBlock en PHPDoc

Conforme va creciendo una aplicación, se va complicando el manejo del proyecto, por ejemplo para que sirva cada clase, cada método, cada atributo, y no solo para el desarrollador, sino para todos los colaboradores  y así ellos puedan entender partes del código sin necesidad de analizar el código línea a línea. ¿Qué es PHPDoc? Wikipedia dice: es una adaptación de javadoc para php que define un estándar oficial para comentar código php, con las siguientes características: Hace comentarios que pueda leerse en un método estándar para animar a los programadores a definir y comentar los aspectos del código que normalmente se ignoran. Permite que los generadores de documentos externos como phpDocumentor puedan crear la documentación API en buen formato y fácil de entender. Permite que algunos IDEs como Zend Studio, NetBeans y Aptana Studio interpreten los tipos de variables y otras ambigüedades en el lenguaje de programación. DocBlock Son bloques de comentarios y se suelen...

Generar documentación PHP – con apigen 2.8 y netbeans 8.0.1

Descargar apigen desde https://github.com/apigen/apigen/downloads   Extraer lo descargado a la carpeta de instalación de php , en mi caso que utilizo wamp seria en C:\wamp\bin\php\php5.5.12  Buscamos y editamos el bat de apigen, ubicada en C:\wamp\bin\php\php5.5.12\apigen\apigen.bat , le damos clic derecho y editar. En la parte que dice “php.exe” lo remplazamos por la dirección completa del intérprete de php, en mi caso es C:\wamp\bin\php\php5.5.12\php.exe, quedando finalmente así: @echo off REM ApiGen 2.8.0 - API documentation generator for PHP 5.3+ REM REM Copyright (c) 2010-2011 David Grudl (http://davidgrudl.com) REM Copyright (c) 2011-2012 Jaroslav Hanslík (https://github.com/kukulich) REM Copyright (c) 2011-2012 Ondřej Nešpor (https://github.com/Andrewsville) REM REM For the full copyright and license information, please view REM the file LICENCE.md that was distributed with this source code. REM IF EXIST "@php_bin@" ( "@php_bin@" "@bin_d...