> Tech > Autodocumentez votre code

Autodocumentez votre code

Tech - Par iTPro - Publié le 09 novembre 2011
email


Personne n'aime vraiment rédiger la documentation. Et comme cette action vient à la fin d'un projet, elle est souvent négligée. Si seulement vous pouviez générer la documentation à partir du code ! Eh bien, vous le pouvez grâce à un utilitaire gratuit appelé phpDocumentor (phpdoc.org). phpDocumentor

recherche les étiquettes at (@) dans des commentaires multilignes (avec un double astérisque spécial suivant la barre oblique d’ouverture du commentaire). Regardez à nouveau le PHP de la figure 1. Vous n'avez probablement pas remarqué les étiquettes spéciales @author, @param, et @return, au premier coup d'oeil. Mais, quand j'ai exécuté la commande phpDocumentor spécifiant mon répertoire source PHP, ces étiquettes spéciales ont généré le HTML de la figure 4. Une page HTML sera générée pour chaque source PHP, en même temps qu'un index et une liste arborescente.

Pour tirer le maximum de phpDocumentor, il vous suffit d'appliquer quelques standards de coding de base pour ajouter des lignes de commentaires qui contiennent les étiquettes phpDocumentor spéciales. Il existe plusieurs dizaines d'étiquettes, entre autres : @author, @example, @global, @method, @name, @package, @param, @property, @return, @see, et @static.

Lorsqu'on écrit du code modulaire, on est vite submergé par la multitude de fichiers PHP, ainsi que par les fonctions et méthodes qu'ils contiennent. Le HTML obtenu avec phpDocumentor est un outil simple et commode pour l'examen et la compréhension de l’API de l'application PHP.
 

Téléchargez gratuitement cette ressource

*** SMART DSI *** VERSION NUMÉRIQUE

*** SMART DSI *** VERSION NUMÉRIQUE

Découvrez SMART DSI, la nouvelle revue du Décideur IT en version numérique. Analyses et dossiers experts pour les acteurs de la transformation numérique de l'entreprise, Gagnez en compétences et expertise IT Professionnelle avec le contenu éditorial premium de SMART DSI.

Tech - Par iTPro - Publié le 09 novembre 2011