Présentation de l'outil Doxygen. Céline SAUBATTE GT du 10 Mars 2009

Dimension: px

Commencer à balayer dès la page:

Download "Présentation de l'outil Doxygen. Céline SAUBATTE GT du 10 Mars 2009"

Gauthier Cartier
il y a 7 ans
Total affichages :

1 1 de l'outil Doxygen Céline SAUBATTE GT du 10 Mars 2009

2 2 Logiciel informatique multi-plateformes Doxygen est la contraction de «dox» (document) et de «gen» (générateur) Permet de générer de la documentation à partir du code source d'un programme Compatible avec de nombreux langages

3 Le logiciel Doxygen 3 Réalisé par Dimitri van Heesch Licence GNU General Public License (GPL) Système de documentation intégré au code source des applications Permet une documentation sur la programmation linéaire, comme sur la programmation orientée objet

4 Les langages compatibles 4 C / C++ / C# Fortran Java Python PHP Objective-C / IDL / VHDL / D

5 Les systèmes d'exploitation compatibles 5 OS utilisées pour son développement : Linux Mac OS X OS compatibles : Windows Unix

6 Les formats de sortie 6 Les formats de sortie sont : HTML (plusieurs fichiers générés dont «index.html») LaTeX (permet par la suite d'obtenir des fichiers postscript, et des fichiers pdf) RTF (compatible avec Microsoft Word) XML Man page (compatible avec le programme «man»)

7 Les dépendances nécessaires 7 Unix, Linux : Compilateur Perl Outils standards de Unix (mv, cp,...) Qt (bibliothèque) Une distribution LaTeX Un interpréteur ghostscript Un compilateur Python La bibliothèque Graph Visualization Windows : Cygwin ou MinGW Visual Studio Installation classique sous Windows

8 La structure de Doxygen 8

9 Fichier de configuration 9 Le fichier Doxyfile : DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = LeProjet OUTPUT_LANGUAGE = English JAVADOC_AUTOBRIEF = YES QT_AUTOBRIEF = NO OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO GENERATE_HTML = YES GENERATE_LATEX = YES PAPER_TYPE = a4wide PDF_HYPERLINKS = YES CLASS_DIAGRAMS = YES

10 Les commentaires simples 10 Plusieurs types de commentaires sont acceptés : /** * modèle JavaDoc */ /*! * modèle Qt */ /// /// modèle C++ /// /*********************************** * Autres modèles ***********************************/

11 Le résultat en HTML 11 Commentaire dans un fichier *.cpp : /** * Premier type de commentaire : C style. */ /*! * Deuxieme type de commenatire : Qt style. */ //! //! Troisieme type de commentaire : C++. //! int main(int argc, char ** argv) { std::cout << "Hello world!" << std::endl; return 0; }

12 Commenter un projet 12 Commenter un projet : /*! * \file exemple7.cpp * \brief Programme de test. * \author Céline * \version 0.1 * \date 10 Mars 2009 * * Programme de test pour commenter une fonction * */

$* \brief Constructeur * * Constructeur de la classe Nombre * * \param x : initialise le premier nombre * \param y : initialise le deuxième nombre */$

13 Commenter une fonction 13 Commenter une fonction : /*! * \brief Constructeur * * Constructeur de la classe Nombre * * \param x : initialise le premier nombre * \param y : initialise le deuxième nombre */ Addition(int x, int y); /*! * \brief Destructeur * * Destructeur de la classe Addition */ virtual ~Addition();

$Les commentaires avancés 14 Commentaires avancés : \namespace : ajoute un onglet «Namespaces» \class$

14 Les commentaires avancés 14 Commentaires avancés : \namespace : ajoute un onglet «Namespaces» \class : ajoute un onglet «Classes» \file : ajoute un onglet «Files» \defgroup : permet de définir un groupe

15 Exemple de documentation HTML 15 Exemple d'une documentation complète en HTML : CBC

16 Exemple de documentation HTML 16 Exemple d'une documentation personnalisée :

17 Exemple de documentation LaTex 17 Exemple d'un document sous Latex : Possibilités de conversion en : - PS - PDF

18 Affichage de diagrammes 18 Doxygen permet de générer des diagrammes : Et plus généralement :

19 Utilisation de Doxywizard 19 Outil Graphique :

20 20 Permet d'avoir une documentation complète d'un développement, que l'on peut facilement mettre à jour. Mise en place d'une norme concernant la réalisation des documents : facilité de lecture et de compréhension. Site officiel :

Documents pareils

Programmation C. Apprendre à développer des programmes simples dans le langage C

Programmation C. Apprendre à développer des programmes simples dans le langage C Programmation C Apprendre à développer des programmes simples dans le langage C Notes de cours sont disponibles sur http://astro.u-strasbg.fr/scyon/stusm (attention les majuscules sont importantes) Modalités