Doxygen

Site officiel
screen_doxygen_sibylle_1 screen_doxygen_sibylle_2
Bookmark and Share

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

Tout d’abord qu’est-ce que Doxygen ? Ceux qui ne développent 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 :


/*! \fn const char *Test::member(char c,int n)
*  \brief Fonction membre.
*  \param c : caractère
*  \param n entier
*  \return un pointeur sur un caractère
*/

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 développeurs qui rejoindrons le projet en cours de route.

M. Billard opine :

J’ajouterai, pour m’en servir, que, contrairement à des bruits qui traînent ici et là, Doxygen est parfaitement capable de générer la documentation d’un code PHP non-objet. Dans l’immédiat, quelques astuces s’imposent :
- Si les commentaires d’une variable ne sont pas pris en compte :

  • supprimer la ligne en italique ci-dessous \var et faire ainsi :

    /**
    {* \var string réponse saisie}
    * \brief string
    * \details chaine de caractères stockant la réponse de l'utilisateur
    */
  • et/ou
  • renommer la variable.

- si les commentaires d’une fonction ne sont pas pris en compte :

  • supprimer la ligne en italique ci-dessous \fn et faire ainsi :

    /**
    {* \fn boolean tester_reponse (saisie)}
    * \brief boolean tester_reponse (saisie)
    * \details teste la validitechaine de caractères stockant la réponse de l'utilisateur
    * \return boolean Resultat
    */
  • et/ou
  • renommer la fonction. Penser que le retour à la ligne se fait avec \n, sans quoi tout ce qui se trouve dans la même rubrique ( \brief, \details..) sera à la queue leu-leu.

En général, si vous êtes certain que la syntaxe du commentaire est juste, et qu’il n’est pas pris en compte, essayez le changement de nom. (Je présume qu’il s’agit d’une faiblesse de la fonction de création des identificateurs)..

Tags: documentation brief
Ajouter des tags (séparés par des virgules ou des espaces) :
 
Attention: tous les caractères spéciaux sont interdits (sauf le .). Les tags n'apparaîtront qu'au prochain rafraichissement du cache (dans plusieurs heures).

<< Mettre à jour >>
:: lien mort :: orthographe :: nouveauté :: mise à jour ::

Vous souhaitez mettre à jour la notice ? La première chose à faire est de déterminer s'il s'agit d'une mise à jour mineure ou d'une mise à jour majeure Icone d'aide.

  • Mineure : un lien mort, des fautes d'orthographe, un lien à ajouter ou encore une petite précision.

    Veuillez renseigner les champs ci dessous :

  • Majeure : une nouvelle version avec des nouveautés, des changements majeurs.

    En cochant cette case, vous allez créer une page sur le wiki afin de mettre à jour la notice.

Commentaires

<< Poster un message >>
:: question :: précision :: avis :: commentaire :: bug ::

Doxygen , le 26 février 2007 par Archron (0 rép.)

Je fais partie d’une équipe de développeur C/C++/C# et nous avnons décidé d’utiliser DOxygne pour générer la documentation utilisateur de tout nos développement. Je dois avoué que j’ai été bluffé par le résultat de la doc HTML. J’ai par contre quelques réserve pour ce qui est du RTF... Il nécessite une reprise systématique... ou alors on a pas tout compris au niveau du paramétrage. Pour les autres formats, je ne peux rien dire. Bref, si on doit se forcer à respecter certains format au niveau des commentaires, on s’y fait très vite et cela devient un réflex, le tout pour un résultat très très pratique !

J’adore :o)

Répondre à ce message

> Doxygen , le 15 juin 2005 (0 rép.)

Je ne suis pas sur que Doxygen génére la doc pour les fichiers HTML...

Répondre à ce message

> Doxygen : francisation , le 6 mai 2005 par erwan (0 rép.)

L’interface du logiciel est en anglais mais la documentation générée peut être en français en modifiant la ligne :

OUTPUT_LANGUAGE = English

en

OUTPUT_LANGUAGE = French

dans le fichier Doxyfile

Répondre à ce message

Informations complémentaires

Faire un don ? (défiscalisé)

Faire un DON

Aidez-nous à atteindre notre objectif de 800 donateurs récurrents pour assurer notre pérennité et notre développement ! (nous n’y sommes plus très loin).

Je soutiens Framasoft pour 10€/mois

Framasoft needs you !

 Vous trouverez ici une liste de logiciels qui ont fait acte de candidature et qui n’attendent que vous pour réussir avec brio l’examen d’entrée dans notre annuaire.

Informations générales

Juste une image

Garbage live i KB Hallen #7 Garbage live i KB Hallen #7
Creative Commons BY

Sur Framabook.org

Atelier Drupal 7
« Atelier Drupal 7 » par Cyprien ROUDET.
Option Libre
« Option Libre. Du bon usage des licences libres » par Benjamin Jean.

Tous nos Framabooks