> Tech > Autodocumentez votre code

Autodocumentez votre code

Tech - Par Renaud ROSSET - 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

Autodocumentez votre code

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 cette ressource

Percer le brouillard des rançongiciels

Percer le brouillard des rançongiciels

Explorez les méandres d’une investigation de ransomware, avec les experts de Palo Alto Networks et Unit 42 pour faire la lumière dans la nébuleuse des rançongiciels. Plongez au cœur de l’enquête pour comprendre les méthodes, les outils et les tactiques utilisés par les acteurs de la menace. Découvrez comment prévenir les attaques, les contrer et minimiser leur impact. Des enseignements indispensables aux équipes cyber.

Tech - Par Renaud ROSSET - Publié le 09 novembre 2011