Version imprimable
http://franckh.developpez.com/tutoriels/outils/doxygen/
Vous pouvez laisser un commentaire pour cet article à la suite.Citation:
Vous désirez créer de la documentation technique pour vos projets de développement ? Ce tutoriel va vous montrer la marche à suivre pour arriver à vos fins avec Doxygen !
:merci:
Hum ... J'avais réagis sur le blog, mais le lien (depuis l'article) ne semble plus valable.
Pour trace, en substance j'avais signalé que,
- sont abordé des tags qui en pratique sont superflus car implicites (et que je n'utilise donc jamais) (\fn, \class, \struct, \namespace, ...). Les tags de formatage me servent bien plus -> %, \c, <em></em>, tirets pour les listes, ...
- manque la famille de tags qui rendent une doc consultable -> \ingroup, \defgroup, etc (je trouve l'immense majorité des docs doxygen/javadoc sont en write-only, toutes les classes étant mises à plat (ou par arbre d'héritage, ce qui ne change rien) sans la moindre organisation ou explication de comment les choses s'utilisent. Définir des groupes permet de mettre un peu de structure aux services proposés et de rajouter des docs chapeau qui parlent de principe et d'intégration)
Bonjour,
:ccool: J'aime bien le tutoriel.
Quelques (petites) remarques :
Je partage l'avis de Luc Hermitte sur les groupes qui permettent de mieux structurer la doc de 'gros' projet.
En C++, j'utilise beaucoup les balises pre, post et invariant aussi.
Quand à docwizard, j'ai récemment mis à jour (sous windows) et la nouvelle version est un peu plus agréable.
Oui! Tout ce qui concerne la PpC, j'en use et abuse aussi.
PS: (je cherchais une autre info quand je suis tombé sur ce post, je suis donc allé un peu vite). Bien aussi. Surtout la partie environnement avec doxywizard qui est probablement ce qu'il y a de plus rédibitoire au départ.
:merci: pour vos remarques cela dit, il ne s'agit que d'une initiation pas d'une documentation complète, juste les bonnes bases pour débuter ;) Cela a tout de même permis à ce tutoriel de servir de support de cours dans deux IUT, un au Québec (Université Laval) et l'autre dans l'école polytechnique universitaire de Nice :mrgreen:
Désolé pour le déterrage de topic, mais je tenais à aussi donner mon avis ! :aie:
Je trouve qu'il est bien fait, et ça va en effet m'aider pour documenter ma lib, mais je pense aussi qu'un peu plus de profondeur aurait été préférable :ccool:
merci pour ce tuto, il va bien me servir.;)