Comparatif des générateurs de documentation PHP

Hugo Étiévant

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.

- Titre : Comparatif des générateurs de documentation PHP

- Auteur : Hugo Étiévant

- Parution : 31 mars 2004

- Mise à jour : 18 août 2007

- Licence : Copyright ® 2004 Developpez LLC. Tous droits réservés Developpez LLC. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents et images sans l'autorisation expresse de Developpez LLC. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- Introduction

- Comparatif

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...

Petit exemple :

/**
* 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)

Version :

1.3.0rc2

Génération hors ligne :

oui

Génération en ligne :

oui

Base de données :

non

Tags personnalisables :

non

Templates personnalisables :

oui

Rapidité :

Assistance :

guide, phpdoc

Formats de sortie :

HTML, CHM, PDF, XML

Licence :

Open Software License

PHPDoc

http://www.phpdoc.de/
(demo)

Version :

1.0beta

Génération hors ligne :

non

Génération en ligne :

oui

Base de données :

non

Tags personnalisables :

non

Templates personnalisables :

non

Rapidité :

Assistance :

documentation en cours de rédaction

Formats de sortie :

HTMl, XML

Licence :

LGPL

phpDoc

http://sourceforge.net/project/?group_id=6109

Version :

0.2.1

Génération hors ligne :

non

Génération en ligne :

oui

Base de données :

oui,MYSQL

Tags personnalisables :

non

Templates personnalisables :

non

Rapidité :

Assistance :

guide, phpdoc

Formats de sortie :

HTML

Licence :

GNU General Public License (GPL)

Doxygen

http://www.stack.nl/~dimitri/doxygen/

Version :

1.3.6

Génération hors ligne :

oui, disponible sous Windows, Mac et Linux

Génération en ligne :

non

Base de données :

non

Tags personnalisables :

oui

Templates personnalisables :

oui

Rapidité :

oui, le plus rapide car compilé

Assistance :

articles, manuel utilisateur

Formats de sortie :

HTML, CHM, PDF, XML

Licence :

GNU General Public License (GPL)

AutoPhpDoc

http://naholyr.free.fr/autophpdoc/

(demo)

Version :

1.1.3d

Génération hors ligne :

oui

Génération en ligne :

oui

Base de données :

non

Tags personnalisables :

non

Templates personnalisables :

non

Rapidité :

Assistance :

manuel, FAQ

Formats de sortie :

HTML

Licence :

GNU General Public License (GPL)

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.