miércoles, 13 de junio de 2007

PHPDocumentor otra buena herramienta para documentar tus proyectos

PHPDocumentor es una herramienta basada en Javadoc para la documentación de código fuente. Esta es una herramienta desarrollada en PHP y usa los mismos principios que Javadoc. La sintaxis es casi la misma que la de Javadoc, por lo que si ya has usado Javadoc ántes no te será problema aplicarlo para php.
Ej. /**
* @var string nombre
*/
var $nombre;
Si le quieres hechar un vistazo aquí te dejo su página web http://www.phpdoc.org., en donde hay un Tutorial que puedes seguir si eres un principiante como yo.
PHPDocumentor puede crear la documentación en diferentes formatos como lo son HTML, PDF, CHM, XML. Para el formato HTML tiene una serie de plantillas que puedes utilizar, pero también te da la opción de crear tu propia plantilla.

Actualizado: 28 de mayo de 2008
Si usas Eclipse como IDE para desarrollar php puedes usar phpdocumentor como una aplicación externa para generar la documentación. En esta página está como instalarlo phpdocumentor en Eclipse

Mediante voy aprendiendo un poco sobre este tema publicaré algunos post con ejemplos.

2 comentarios:

Dan dijo...

PHPDocumentor en Eclipse:

La url que proporcionas no existe o no rula.

Danilo Domínguez P. dijo...

Dan: tienes razón el link parece que caduco, cuando encuentro otra referencia actualizo el post, si encuentras una ántes me la mandas ;)

Saludos ...