En principe, il est préférable de documenter le code source de nos applications web ! Ce n’est spécialement une partie de plaisir, aussi, l’assistance d’outils pour nous aider dans cette tâche est bienvenue !
phpDocumentor est un générateur de documentation pour PHP et à pour fonction de créer une documentation de votre programme source. Pour y parvenir, il s’appuie sur les commentaires inclus à l’intérieur de votre code source. D’où l’importance de bien expliciter vos routines, fonctions et autres procédures.
Les caractéristiques principales de phpDocumentor sont :
- Génération hors ligne
- Génération en ligne
- Templates personnalisables
- guide, phpdoc
- Formats de sortie en HTML, CHM, PDF, XML
Avoir recours à phpDocumentor vous permettra de pouvoir revenir sur un code après un long moment, de permettre à d’autres développeurs de voir en un clin d’oeil la structure de votre application et une meilleure maintenance du code.
Site Internet : phpDocumentor
Licence : Open Sofware License
Dans le même registre il y a aussi Doxygen, un autre très bon générateur de documentation.
http://www.stack.nl/~dimitri/doxygen/