#1 Le 04/04/2008, à 10:29
- Le Farfadet Spatial
[Résolu] Documentation automatique en C++
Salut à tous !
Je suis en train de mettre en place la documentation d'un projet de taille importante codé en C++. Pour l'instant j'utilise Doxygen et je trouve ça vraiment bien. Cela dit, sait-on jamais : peut-être y a-t-il d'autre logiciel qui font aussi bien voire mieux en matière de documentation générée automatiquement. En connaissez-vous ?
À bientôt.
Le Farfadet Spatial
Dernière modification par Le Farfadet Spatial (Le 04/04/2008, à 20:07)
Hors ligne
#2 Le 04/04/2008, à 10:42
- Karl_le_rouge
Re : [Résolu] Documentation automatique en C++
Pour du C++, je confirme y a pas mieux.
Hors ligne
#3 Le 04/04/2008, à 12:38
- Luc Hermitte
Re : [Résolu] Documentation automatique en C++
Il y a d'autres,forks ou pas de dox++ ou de doxygen, mais dans l'ensemble doxygen me convient mieux.
Il y a des petites règles à suivre pour bien documenter son code (ça va être long -> a faire au fur et à mesure). Je ne peux que te conseiller de grouper les composants et autres sous-composant de ton projet, surtout s'il est volumineux. C'est le détail, qui AMHA, rend l'utilisation de doxygen pertinente et utile à autre chose qu'à remplir des classeurs qui iront s'entasser sur des étagères.
#4 Le 04/04/2008, à 20:06
- Le Farfadet Spatial
Re : [Résolu] Documentation automatique en C++
Salut à tous !
Bon, il semble y avoir consensus. Très bien, je garde Doxygen, considérons donc le problème comme résolu. Merci de vos réponses.
Ne t'en fais pas, Luc, la documentation ne restera pas dans un placard. Cela dit, d'une part c'est un projet qui a déjà trois ans d'existence et qui se base sur un projet plus ancien, d'autre part il est assez loin de l'application Java avec base de données classique du génie logiciel --- pour ne rien cacher, il s'agit d'un modèle numérique océanographique... Donc, il y a bien une structure à mettre en place, mais il est vrai qu'elle ne correspond pas vraiment à ce qu'on peut voir usuellement déployé dans les projets classiques. Par exemple, j'ai totalement abandonné la modélisation UML, qui n'apporte rien dans ce cas et qui fait perdre du temps. À l'inverse, il y a un gros travail théorique, qui est publié sous forme d'article dans des revues scientifiques à comité de relecture, soit par nous (l'équipe de développement du modèle), soit par d'autres. Il y a tout un travail de compilation et d'organisation autour de la littérature.
Bref, Doxygen ne me sert qu'à une partie de la documentation, mais justement celle sur laquelle nous avons le plus de retard. Néanmoins, je te remercie : tout retour d'expérience est bon à prendre.
À bientôt.
Le Farfadet Spatial
Hors ligne