Doxygen

Accrochez-vous, voici la présentation d’un outil d’aide au developpement extraordinaire, utilisé par des nombreuses equipes de développement, comme celles de KDE, IBM et Mozilla.

Tout d’abord qu’est-ce que Doxygen ? Bon, ceux qui ne developpent pas ne trouveront sûrement pas cela fantastique, mais c’est un logiciel qui permet de générer une documentation du code source à partir de ses commentaires, donc dans le style de javadoc, mais en beaucoup plus puissant !

Voyons maintenant ses fonctionnalités.

Tout d’abord Doxygen est compatible avec de nombreux languages : C++, C, PHP, Perl, HTML, alors que javadoc lui se cantonne au Java.

Son fonctionnement est d’une grande simplicité : vous programmez normalement mais commentez votre code de manière un peu spéciale (mais pas trop) : par exemple le commentaire d’une fonction serait :

Ensuite vous configurez Doxygen. Grâce à une interface graphique des plus sympathiques vous pouvez par exemple :

• Choisir le format de sortie (HTML, rtf, LaTeX, XML et même man pour les puristes !).
• Configurer finement le format de sortie (par exemple HTML sans ou avec frames, avec telle feuille de style CSS...).
• Générer automatiquement des diagrammes UML et même utiliser GraphViz pour faire des diagrammes encore plus beaux.
• Intégralement compatible avec les tags javadoc, donc rien à changer si vous utilisiez cet outil.

Et hop, vous n’avez plus qu’à cliquer sur start et voilà un belle documentation qui ravira tous les developpeurs qui rejoindrons le projet en cours de route.