Documentación automática en PHP

10 views
Skip to first unread message

Eduardo Inza

unread,
Aug 16, 2011, 4:18:26 AM8/16/11
to PHP Madrid
Hola a todos,

Este tema no está directamente relacionado con Symfony pero creo que
abrir el tema sería bastante constructivo. ¿Utilizáis alguna
herramienta de documentación automática como phpDocumentor? ¿Cuál?
¿Por qué?

Todo esto viene porque tengo un proyecto entre manos que va engordando
deprisa y que dentro de poco será inmanejable como no mejore la
documentación rápido.

PD: Mis disculpas a los que estéis también en la lista de Symfony y
recibáis este mail duplicado.

Atte. Eduardo Inza
http://eduardo.inza.com

Ángel Luis Quesada Nieto

unread,
Aug 16, 2011, 4:21:09 AM8/16/11
to phpm...@googlegroups.com

PHPDoc siempre y documentar todo desde el principio. Antes incluso que tirar una sola linea de código dentro del método.

A nosotros nos ha ido siempre genial PHPDoc.

Un saludo,

Ángel Luis Quesada

Company: http://kubide.es
Web: http://alquesada.es
Telf: 669783539
Skype: alquesada.com
Email / Gtalk: alqu...@gmail.com
Twitter: gelito



2011/8/16 Eduardo Inza <eduard...@gmail.com>

--
Has recibido este mensaje porque estás suscrito al grupo de correo "PHP Madrid".
Para enviar un email a todos los miembros del grupo dirígete a phpm...@googlegroups.com
Para abandonar el grupo envía un email a la dirección phpmadrid+...@googlegroups.com
Para otra opciones o para ver la web del grupo:
http://groups.google.com/group/phpmadrid?hl=es

Eduardo Inza

unread,
Aug 16, 2011, 4:35:36 AM8/16/11
to phpm...@googlegroups.com
Sí, documentado lo tenemos en el código (mas o menos) pero el problema
es a la hora de leer la documentación... Que está muy repartida en
varios ficheros.

PHPdoc está congelado (sin releases en su página oficial) desde
2009... Y su lista de correo está como muerta. :-s

Atte. Eduardo Inza
http://eduardo.inza.com

El día 16 de agosto de 2011 10:21, Ángel Luis Quesada Nieto
<alqu...@gmail.com> escribió:

Ángel Luis Quesada Nieto

unread,
Aug 16, 2011, 4:51:09 AM8/16/11
to phpm...@googlegroups.com
Yo creo que se congeló porque no podía continuar... digamos que llegaron "a la versión estable definitiva de la muerte" xD

Aun así funciona genial.

Nosotros trabajamos todo (absolutamente TODO) orientado a objetos, no hay ni una sola función fuera de esto (lo más es un $c = new SomeClass(); $c->main(); en el index.php) y en varios archivos (hay proyectos con 20 archivos de clases propios más librerías) y no hemos tenido ningún problema en crear la documentación con PHPDoc.

Así que ánimo y a documentar! :-p

Reply all
Reply to author
Forward
0 new messages