PHP – Outils de documentation

Table des matières

1. phpDocumentor

https://github.com/phpDocumentor/phpDocumentor2

1.1. installation

composer require --dev phpdocumentor/phpdocumentor dev-master

1.2. Utilisation

Par exemple, créer un dossier /docs à la racine du site puis, toujours depuis une session DOS, lancer une requête comme :

vendor\bin\phpdoc run -d <SOURCE_DIRECTORY> -t <DOCS_DIRECTORY>

Par exemple, créer un dossier /docs à la racine du site puis, toujours depuis une session DOS, lancer une requête comme ci-dessous pour documenter le dossier /src :

vendor\bin\phpdoc run -d src -t docs

2. Apigen – Gestionnaire de documentation pour PHP

Smart and Readable Documentation for your PHP project

https://github.com/ApiGen/ApiGen

(alternative à php-doc)

2.1. Installation

Ouvrir une session DOS, se rendre dans le dossier racine du projet PHP et lancer l’instruction composer require apigen/apigen --dev pour installer la dépendance pour le mode de développement.

Si cela ne devrait pas fonctionner (octobre 2018), il faut éditer composer.json pour ajouter la dépendance vers la branche dev-master comme ceci :

"require-dev": {
    "apigen/apigen": "dev-master"
}

2.2. Utilisation

vendor\bin\apigen generate <SOURCE_DIRECTORY> --destination <DOCS_DIRECTORY>

Par exemple, créer un dossier /docs à la racine du site puis, toujours depuis une session DOS, lancer une requête comme ci-dessous pour documenter le dossier /src :

vendor\bin\apigen generate src --destination docs

Cette requête demande à générer la documentation des scripts situé dans le dossier src et de stocker le résultat dans le dossier docs.