Page de garde Doc++ Maîtrise dinformatique Février 2002.

Présentation au sujet: "Page de garde Doc++ Maîtrise dinformatique Février 2002."— Transcription de la présentation:

1 Page de garde Doc++ Yannis.BRES@cma.inria.fr Maîtrise dinformatique Février 2002

2 Doc++ Un extracteur de documentation pour programmes et bibliothèques en C, C++, IDL et Java, générant de lHTML ou du TeX, assez similaire à JavaDoc. Pour consommer : http://docpp.sourceforge.net Pour produire : http://sourceforge.net/projects/docpp

3 Format des commentaires Doc++ utilise les commentaires précédant les déclarations de classes, de méthodes, de fonctions, de typedef s, de macro, … de la forme : /** * Description de ce qui suit. */ ou (sur une seule ligne) : /// Description de ce qui suit. Par défaut, la première phrase est utilisée pour la documentation courte et la totalité du commentaire pour la version longue, mais il est possible de préciser : /** * @memo * Description courte de ce qui suit. * * @doc * Description longue de ce qui suit. */

4 Les tags Doc++ Doc++ utilise des tags pour typer les informations contenues dans les commentaires. @author : pour indiquer le ou les auteurs @deprecated : pour les déclarations obsolètes @doc : documentation longue @exception : documentation des exceptions lancées @invariant : spécification dinvariant de classe @memo : documentation courte @param : documentation des paramètres @postcondition : spécification de postcondition de fonction/méthode @precondition : spécification de précondition de fonction/méthode @return : documentation du résultat renvoyé (ou des différentes valeurs possibles) @see : références croisées @since : version du programme à laquelle est apparue la déclaration @version : version courante du programme Les principaux tags sont :

5 Groupement des déclarations Les déclarations peuvent être groupées en les précédant de : /** * @name Nom du groupe * Description du groupe */ //@{ et en les faisant suivre de : //@} Les groupes de mêmes noms répartis sur plusieurs fichiers sont automatiquement assemblés. Les groupes peuvent à leur tour contenir dautres groupe.

6 Utilisation de tags HTML ou de commandes LaTeX Doc++ permet lutilisation de tags HTML ou de commandes/environnements LaTeX courants :,,,,,,,,,,,,, … $…$, \[…\], \#, \-, \, \em, \emph, \bf, \textbf, \it, \textit, \tt, \texttt, verbatim, tabular, array, itemize, enumerate, description, item, …

7 Le fichier de configuration Les options de Doc++ peuvent être spécifiées sur la ligne de commande, mais il est plus lisible de faire cela via un fichier de configuration. Doc++ se lance alors par : doc++ --config projet.conf fichiers Le format du fichier de configuration est très simple. Par exemple : documentAll false documentPrivateMembers false HTMLSyntax true internalDoc false upwardsArrows true useTables false outputDir M:\Esterel\Docs\libv7 showMembersInTOC true