Crea la documentación de tu proyecto con PhpDocumentor.

Cuando se trabaja con grandes proyectos en php, es importante tener una buena documentación de las clases y funciones de todo el proyecto, lo cual ayuda a la corrección de errores o a futuras modificaciones y desarrollos.

Para crear esta documentación de manera rápida y automática existe PhpDocumentor, es una herramienta libre que genera un HTML con toda la documentación de tu proyecto, así como un reporte de errores del mismo.

Descarga
Baja la ultima version de la web del autor: www.phpdoc.org

Instalación
Descomprime el archivo en tu servidor web, este puede ser local o en linea.

Configuración
En la direccion ..\PhpDocumentor\user duplica el archivo default.ini y ponle un nombre, ejempo: mi_proyecto.ini



Abre el archivo y modifica lo siguiente:

Ruta donde se guardara la documentacion creada
target = /you-MUST/change-me/to-fit/your-environment

Ejemplo: target = C:\Users\Documents\Documentacion de mi_proyecto

Ruta donde están los archivos de tu proyecto
directory = /you-MUST/also-change-me/to-fit/your-environment

Ejemplo: directory = C:\AppServ\www\mi_proyecto

Guarda los cambios.

Crear documentación
Entra a la aplicación de PhpDocumentor y en el Menú elige la opción Config, en la lista elige la configuración que creaste mi_proyecto y presiona Go, comenzara a crearse la documentación en el directorio que elegiste.


Saludos, no olviden seguirme Twitter @pandurito

No es que esté mal, pero es un poco perezoso este tuto. No muestras el proceso, las reglas ni el resultado final. Ni siquiera un screenshot.

Por ahora, lo paso a Aportes.

El aporte esta hecho y el screenshot esta al final, quizá no aparece porque tome la URL equivocada de la imagen. Seria menos problema si en l4c.me mostraras la URL que se debe utilizar para postear cada imagen de la galería de un usuario.

Hola, si es cierto le faltan cosas pero es el primer tutorial que explica claro y en pocos pasos como hacer funcionar phpDocumentor