{"id":5427,"date":"2016-08-24T14:00:12","date_gmt":"2016-08-24T14:00:12","guid":{"rendered":"http:\/\/anthroponaute.fr\/blog-informatique\/?p=5427"},"modified":"2016-09-01T06:02:40","modified_gmt":"2016-09-01T06:02:40","slug":"utilisez-doxygen-pour-documenter-vos-programme-en-html","status":"publish","type":"post","link":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/?p=5427","title":{"rendered":"Utilisez Doxygen pour documenter vos programme C++ en HTML"},"content":{"rendered":"

\"Doxygen_logo\"<\/a><\/p>\n

Intro :<\/strong><\/p>\n

La documentation d’un programme est une \u00e9tape fondamentale<\/strong> dans sa compr\u00e9hension<\/strong>.<\/p>\n

Le programme Doxygen permet la g\u00e9n\u00e9rer automatiquement<\/strong> sous couvert d\u2019alimenter le programme en commentaires de code !<\/p>\n

Pr\u00e9requis :<\/strong><\/p>\n

Explications :<\/strong><\/p>\n

Voici les tags \u00e0 utiliser dans vos programmes en tant que commentaires :<\/p>\n

\\struct<\/strong> pour documenter une structure C.
\n\\union<\/strong> pour documenter une union C.
\n\\enum<\/strong> pour documenter un type \u00e9num\u00e9r\u00e9.
\n\\fn<\/strong> pour documenter une fonction.
\n\\var<\/strong> pour documenter une variable \/ un typedef \/ un \u00e9num\u00e9r\u00e9.
\n\\def<\/strong> pour documenter un #define.
\n\\typedef<\/strong> pour documenter la d\u00e9finition d’un type.
\n\\file<\/strong> pour documenter un fichier.
\n\\namespace<\/strong> pour documenter un namespace.
\n\\package<\/strong> pour documenter un package Java.
\n\\interface<\/strong> pour documenter une interface IDL.
\n\\brief<\/strong> pour donner une description courte.
\n\\class<\/strong> pour documenter une classe.
\n\\param<\/strong> pour documenter un param\u00e8tre de fonction\/m\u00e9thode.
\n\\warning<\/strong> pour attirer l’attention.
\n\\author<\/strong> pour donner le nom de l’auteur.
\n\\return<\/strong> pour documenter les valeurs de retour d’une m\u00e9thode\/fonction.
\n\\see<\/strong> pour renvoyer le lecteur vers quelque chose (une fonction, une classe, un fichier\u2026).
\n\\throws<\/strong> pour documenter les exceptions possiblement lev\u00e9es.
\n\\version<\/strong> pour donner le num\u00e9ro de version.
\n\\since<\/strong> pour faire une note de version (ex : disponible depuis\u2026).
\n\\exception<\/strong> pour documenter une exception.
\n\\deprecated<\/strong> pour sp\u00e9cifier qu’une fonction\/m\u00e9thode\/variable\u2026 n’est plus utilis\u00e9e.
\n\\li<\/strong> pour faire une puce.
\n\\todo<\/strong> pour indiquer une op\u00e9ration restant \u00ab \u00e0 faire \u00bb.
\n\\fixme<\/strong> pour indiquer un code d\u00e9fectueux, \u00ab \u00e0 r\u00e9parer \u00bb.<\/p>\n

R\u00e9sum\u00e9 :<\/strong><\/p>\n

Nous avons pr\u00e9sent\u00e9 le programme Doxygen qui vous permettra de documenter \u00e0 la vol\u00e9e tout votre code !<\/p>\n

R\u00e9f\u00e9rences :<\/strong><\/p>\n

– https:\/\/fr.wikipedia.org\/wiki\/Doxygen<\/p>\n

– http:\/\/franckh.developpez.com\/tutoriels\/outils\/doxygen\/<\/p>\n

– http:\/\/axiomcafe.fr\/tutoriel-documenter-un-code-avec-doxygen<\/p>\n","protected":false},"excerpt":{"rendered":"

Intro : La documentation d’un programme est une \u00e9tape fondamentale dans sa compr\u00e9hension. Le programme Doxygen permet la g\u00e9n\u00e9rer automatiquement sous couvert d\u2019alimenter le programme en commentaires de code ! Pr\u00e9requis : Explications : Voici les tags \u00e0 utiliser dans vos programmes en tant que commentaires : \\struct pour documenter une structure C. \\union pour […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[3],"tags":[],"_links":{"self":[{"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=\/wp\/v2\/posts\/5427"}],"collection":[{"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=5427"}],"version-history":[{"count":11,"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=\/wp\/v2\/posts\/5427\/revisions"}],"predecessor-version":[{"id":5728,"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=\/wp\/v2\/posts\/5427\/revisions\/5728"}],"wp:attachment":[{"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5427"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=5427"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.la-porte-des-nebuleuses.net\/blog-informatique\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=5427"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}