PHPXref: Documenta tus codigos facilmente

PHPXref es un proyecto open source escrito en perl es cual nos genera una documentación basado en referencias cruzadas de nuestro proyecto php.

PHPXref referencia todas las variables, funciones, clases, y constantes de nuestro código con lo cual genera una interfase amigable con un explorador de archivos en forma de árbol al lado izquierdo el cual nos permitirá navegar por todos los archivos fuentes de nuestro proyecto.
Algo a resaltar es son las búsquedas son bien detalladas a mi gusto, solo escribes la función o la clase que buscas y te mostrara una lista de archivos y la línea donde se definió o la referencia de dicha función o clase y tienes la posibilidad de dirigirte al archivo donde te mostrara el código fuente (con la sintaxis coloreada) y la línea exacta donde se ubica tu búsqueda :).
Gracias a PHPxref la tarea de documentación de proyectos php es sumamente fácil ahorrandonos horas de trabajo.

Requerimientos

1. PHPXref Descargalo
2. Perl 5.6 o mayor (Se sabe que funcionan bien en OS X, Linux y Windows)
3. Un proyecto en php o algunos archivos en php de prueba.

Instalación

1. Descomprimir el archivo phpxref-0.x.tar.gz
2. Copiar todo el código php de tu proyecto a documentar en la carpeta /phpxref/source/
3. Editar el archivo phpxref.cfg para personalizar la documentación (opcional).
4. Ejecutar el archivo phpxref.pl ( phpxref.bat en Windows).
5. Ejecutar el archivo /phpxref/output/index.html para ver la documentación.

Personalizar nuestra documentación

Parámetros principales en el archivo phpxref.cfg

# El parámetro "SOURCE" identifica la carpeta donde
# están nuestros archivos php a documentar por defecto "source"
SOURCE=source
# El parámetro "OUTPUT" identifica la carpeta donde
# se generara la documentación por defecto "output"
OUTPUT=output
# El parámetro "PROJECT" será el nombre de nuestro
# proyecto el cual se añadirá en el titulo principal de
# la documentación por defecto "Unnamed Project"
PROJECT=Unnamed Project
# El parámetro "HEADERFILE" identifica la plantilla
# de la cabecera con cual se generara la documentación
HEADERFILE=sample_header.html
# El parámetro "FOOTERFILE" identifica la plantilla
# del pie de pagina con cual se generara la documentación
FOOTERFILE=sample_footer.html
# El parámetro "STYLEFILE" identifica al archivo
# de estilos con cual se generara la documentación
STYLEFILE=sample.css
# El parámetro "PRINTSTYLEFILE" identifica el archivo
# de estilos para impresión con cual se generara la documentación
PRINTSTYLEFILE=sample-print.css
# El parámetro "CHARSET" identifica al juego de caracteres HTML
# con cual se generara la documentación por defecto "iso-8859-1"
CHARSET=UTF-8
# El parámetro "EXTENSION" identifica la extensión con la cual
# se generar los archivos de la documentación por defecto "html"
EXTENSION=html
# El parámetro "FUNCTIONLIST" identifica al archivo con el listado
# de funciones de php en este caso PHP4
FUNCTIONLIST=php4_functionlist.txt
# El parámetro "BAD_EXT" identifica la extensión de los archivos
# que no serán tomados en cuenta, en la documentación
BAD_EXT=bz2
BAD_EXT=gz
BAD_EXT=zip
BAD_EXT=exe
BAD_EXT=bin
BAD_EXT=dat
BAD_EXT=core
BAD_EXT=gif
BAD_EXT=jpg
BAD_EXT=png
BAD_EXT=prc
BAD_EXT=tgz
BAD_EXT=ico
#Para mi los más principales parámetros para la configuración:).

La prueba la realice con Wordpress 2.6 lo iba a subir pero me doy cuenta que en PHPXref existen un numero significativo de Proyectos PHP ya documentados que están categorizados por secciones y actualizados a su ultima versión.

• CMS
• Portal
• Blog
• Forum
• Gallery
• Wiki
• Customer
• Workspace
• Learning
• Program
• Utility

Entre ellos Wordpress 2.6 el cual es una buena opción entre la guía del Codex o
la lista de funciones completas de WordPress.