netbeans phpdoc

En esta ocasión os traigo un artículo de cómo configurar Netbeans e instalar phpDoc para documentar el código PHP de nuestros proyectos.

Dando por hecho que en la máquina está instalado tanto PHP como Apache:

PASOS PARA INSTALAR PHPDOC Y CONFIGURAR NETBEANS:

1. Instalar PEAR:
– c:\Archivos de programa\PHP\go-pear.bat
– Elegir “local”
– Escribir “yes”
– Presionar enter
– Modificar el php.ini y añadir: C:\Archivos de programa\PHP\PEAR (reiniciar apache)

2. Instalar Php Documentor en netbeans:
Tools->plugins->downloaded-> add -> archivo

3. Seleccionar el script de phpdoc en netbeans:
Tools->options->phpdoc->search->phpdoc.bat

4. Copiar la carpeta PhpDocumentor-1.5.0a1 en C:\. (descomprimir)

Para ello deberemos haberla descargado previamente: phpDoc

*Nota: En este caso se ha utilizado la versión 1.5 de PhpDocumentor, pero se podría usar otra y descargarla del sitio oficial.
5. En la carpeta de php, editar phpdoc.bat:
– arriba del todo hay que sustituir/incluir la siguiente configuración (poniendo vuestro nombre de usuario en “Documents and Settings”):

  1. SET phpCli=C:\Archivos de programa\php\php.exe
  2. cd C:\Documents and Settings\velena

– y buscar la siguiente configuración para que quede algo similar a:

  1. SET iniFile=
  2.  
  3. ECHO ------------------------------------------------------------------------------
  4. ECHO Select Ini-File [default is <span id="DWT118" class="ZmSearchResult"><span id="DWT120" class="ZmSearchResult">phpDoc</span></span>umentor.ini]
  5. ECHO ------------------------------------------------------------------------------
  6. ECHO # 0: <span id="DWT122" class="ZmSearchResult"><span id="DWT124" class="ZmSearchResult">phpDoc</span></span>umentor.ini
  7. SET count=0
  8. FOR /R "C:\<span id="DWT126" class="ZmSearchResult"><span id="DWT129" class="ZmSearchResult">PhpDoc</span></span>umentor-1.5.0a1\user" %%I IN (*.ini) <span id="OBJ_PREFIX_DWT127_com_zimbra_date" class="Object"><span id="OBJ_PREFIX_DWT130_com_zimbra_date" class="Object">DO</span></span> (
  9. SET /a count+=1
  10. CALL :exec ECHO # %%count%%: %%~nI%%~xI
  11. )

 

6. El formato de utiliación de php doc en el código es:
CLASES:
/**
* Descripción de la clase.
*
* @package Carpeta a la que pertenece (si tienen varios niveles se pueden concatenar con “\”)
* @author Nombre del autor
*
*/

MÉTODOS:
/**
* Descripción del método
*
* @param type $variable Descripción del parámetro de entrada
* @return type Descripción de lo que retorna
*
*/

Para más información sobre los tags (hay más): http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html

 

7. Para generar la documentación desde netbeans:

Botón derecho del ratón sobre el proyecto->generate documentation->phpdoc