Si vous codez de manière régulière, vous devez savoir que les développeurs détestent commenter leur code ou faire la moindre documentation. Et pourtant, que ce soit pour la même personne ou pour ceux qui reprendront le code un jour, cela est vraiment indispensable si on veut s’y retrouver ou générer un manuel de son code.
C’est pour les aider dans cette tâche que Clément Nedelcu a mis au point PHPDocFill, une application gratuite et open source qui analyse le code contenu dans tous les fichiers PHP de votre projet et qui insère des blocs PHPDoc préformatés devant chaque élément.
Vous pouvez ainsi coder comme un porc et y revenir plus tard pour éditer cette documentation PHP en étant sûr de ne rien oublier.
Comme c’est du PHPDoc (standard), il est ensuite possible de générer automatiquement une documentation HTML avec index des éléments et commentaires associés.