Introduction▲
Ce comparatif s'inspire du thread Que pensez-vous des générateurs de doc PHP ? du forum PHP de Developpez.com
Un générateur de documentation pour PHP génère une documentation de votre code source à partir des commentaires inclus directement dans le code. Leur fonctionnement est identique à JavaDoc. Ainsi, d'autres développeurs peuvent connaître en un coup d'oeil vos interfaces ainsi que la structure de vos applications. Ceci, pour une meilleure diffusion de vos sources et une maintenabilité assurée. Essentiel lorsqu'on travaille en groupe. Et fortement recommandé si vous voulez être en mesure de comprendre votre code un an après...
/**
* Cette fonction formate et affiche une chaîne de caractères dans la sortie standard.
*
@author
Hugo ETIEVANT
*
@param
str Chaîne à afficher
*
@param
format Chaîne décrivant le format d'affichage
*
@since
3
.
2
*
@return
un booléen valant
True
si l'affichage c'est bien passé,
False
sinon
*/
function print(str,
format) {
...
}
Remerciements à Rmotte et à armatatuxa pour leurs corrections.
Comparatif▲
Ce logo stigmatise les outils préférés des membres de Developpez, d'après leur débat dans le forum PHP. Ils ont été testés et sont conseillés, des explications spécifiques pourront être trouvées dans le thread indiqué plus haut.
Tous ces outils sont gratuits.
AutoPhpDoc | Doxygen | PHPDoc | phpDoc | phpDocumentor |
phpDocumentor http://www.phpdoc.org/ (demo) |
|
||||||||||||||||||||
PHPDoc http://www.phpdoc.de/ (demo) |
|
||||||||||||||||||||
phpDoc
http://sourceforge.net/project/?group_id=6109 |
|
||||||||||||||||||||
Doxygen
http://www.stack.nl/~dimitri/doxygen/ |
|
||||||||||||||||||||
AutoPhpDoc http://naholyr.free.fr/autophpdoc/ (demo) |
|
Les informations données ici le sont à titre indicatif, elles étaient à jour au moment de leur rédaction, je ne suis pas responsable de l'évolution des outils cités ici. Seules les informations publiées sur leurs sites officiels font foi.