L’outil phpDoc

phpDoc est une aide qui permet de générer un squelette de documentation sur vos sources PHP. On le trouve sur le site officiel

Pour l’installation, on ne peut pas faire plus simple : décompressez l’archive dans un répertoire de votre site et allez-y avec votre navigateur préféré. Si tout va bien il devrait vous afficher ça :

Passons tout de suite à la pratique : on va tester un des exemples fournis. Ils sont dans le répertoire tutorials/phpDocumentor/examples de phpdoc.
Dans l’onglet files on donne le chemin d’un de ces fichiers :

Dans l’onglet "output" il reste à définir le dossier de destination de la documentation générée et son format et si tout va bien :

Formidable !! nous avons créé notre première doc !

Rajoutons des commentaires compréhensibles par phpdoc :

La première chose à savoir est que vos commentaires doivent ressembler à :

A l’intérieur de ces blocs, on a des mots clés à définir.

Par exemple, dans l’entête du fichier, on peut définir « @package » qui permet de grouper des fichiers dans la doc.