PHP - Génération de documentation avec phpDocumentor

1 1 1 1 1 1 1 1 1 1 Rating 0.50 (1 Vote)
Submit to DeliciousSubmit to DiggSubmit to FacebookSubmit to Google PlusSubmit to StumbleuponSubmit to TechnoratiSubmit to TwitterSubmit to LinkedIn

phpDocumentor est un outil de génération de documentation écrit en PHP semblable à l'outil Javadoc en analysant le code source des fichiers PHP et en générant la documentation au format HTML, PDF, CHM ou Docbook.

Installation de phpDocumentor

Installation sous Linux/Debian

Sous debian, vous pouvez installer la dernière version de phpDocumentor simplement avec la commande :

pear channel-discover pear.phpdoc.org
pear install phpdoc/phpDocumentor

Si vous n'avez pas installer PEAR : Installer PEAR

Vérification de l'installation

Pour vérifier que l'installation a bien été réalisée, vous pouvez exécuter la commande ci-dessous :

phpdoc --help

Et :

phpdoc --version

Pour connaitre la version de phpDocumentor.

Exemple d'utilisation

Nous allons réaliser une class qui permet d'ajouter, soustraire, multiplier et diviser deux nombres qui est en faite la suite du tutoriel PHP - Tests unitaires avec PHPUnit .

Télécharger le code source : PHP - Génération de documentation avec phpDocumentor

Pour exécuter phpDocumentor, il faut se mettre à la racine du code source puis exécuter la commande ci-dessous : 

phpdoc -d doc -d /var/www/www/test/phpunit.calculator

L'option -d permet d'analyser le répertoire. Dans mon cas c'est /var/www/www/test/phpunit.calculator

Si tout c'est bien passé, un répertoire output c'est généré, vous pouvez lancer le fichier index.html dans le répertoire output.

La documentation de phpDocumentor : http://phpdoc.org/ 

Submit to DeliciousSubmit to DiggSubmit to FacebookSubmit to Google PlusSubmit to StumbleuponSubmit to TechnoratiSubmit to TwitterSubmit to LinkedIn