phpDoc

https://www.phpdoc.org/

Installation

Quatre possibilités donc avec PEAR, Composer, PHAR ou manuellement.

En mode manuel :

After you have done the above can the executable be found at bin/phpdoc.php in the installation directory.

Générer une documentation

En ligne de commande, se placer dans le dossier parent du dossier qui contient le code source (p.ex. C:\Christophe\Repository\ si on souhaite générer la documentation pour le dépôt marknotes).

Puis exécuter phpdoc -d marknotes (-d suivi du nom du dossier enfant) *le dossier output est créé avec la documentation

Autres exemples :

Batch

On peut aller un peu plus vite avec ce script :

mkdir docs
cd docs
phpdoc -d ..\marknotes -t .
rm -r phpdoc-cache-*
cd ..

Il permet de créer le dossier docs qui va contenir la documentation. Il va lancer phpdoc sur le dossier marknotes (à remplacer donc par le nom du projet à documenter) puis il supprime les nombreux dossiers phpdoc-cache-xx qui auront été créé par phpdoc.

FAQs

Could not find /phpdoc

À l’exécution de phpdoc en ligne de commande, l’erreur suivante pourrait survenir : Could not open input file: /phpdoc. Si cela arrive, il faut éditer les variables d’environnement Windows et en créer une nouvelle.