
Hace ya muchos años, en un curso muy lejano….
Así empieza la historia. Corría 2006 y yo empezaba a programar en C++. En una asignatura llamada Metodología de la Programación 2 (MP2 para los amigos) nos enseñaron un programa con su propia sintaxis para documentar código, doxygen, un paquete de software GNU/GPL que facilitaba tanto la escritura de la documentación como su posterior consulta.
Genera informes en PDF, PS, HTML (los más interesantes, totalmente navegables con enlaces y referencias a 1 click de distancia) con toda la información documentada en perfecto castellano (o el idioma que se elija) y una presentación muy intuitiva e impecable. Además, su configuración es sencillísima y se encuentran numerosos tutoriales y ficheros de ejemplo en la web.
Recuerdo esto ahora pues en nuestro paquete Paypal estamos usando doxygen con PHP. Sí, sí, también sirve para documentar PHP, y Java, y Python… Con una sintaxis idéntica para todos ellos y una configuración en un 98% similar. Una delicia para la documentación que mejora la reutilización y modificabilidad de nuestros proyectos.
Existe gran cantidad de información en la página oficial y una lista de proyectos abiertos para documentar con doxygen.