Documenter ses sources avec Doxygen

Documenter ses sources avec Doxygen - C - Programmation

Marsh Posté le 07-02-2009 à 20:02:49    

Bonsoir,
 
Je bosse avec d'autres étudiants sur un petit projet et nous voulons utiliser doxygen afin de générer une bien jolie documentation à la fin de notre projet.
J'ai une petite question à ce propos que je n'ai pas résolue en cherchant sur le site, et dans d'autres exemples ...
 
Mes prototypes de fonctions figurent dans des fichiers headers. Où dois-je alors placer les commentaires qui les accompagnent ?
Dans le header, ou dans le fichier source ?
 
par exemple :

Code :
  1. /** Ma super fonction  
  2. * @param pouet un entier
  3. * @return le même entier
  4. */
  5. int superfonction(int pouet) {
  6.     return pouet;
  7. }


 
Merci d'avance

Reply

Marsh Posté le 07-02-2009 à 20:02:49   

Reply

Marsh Posté le 08-02-2009 à 13:37:13    

en général on le mets de les headers car on ne fournit pas forcement le source.  
Mais doxygen te laisse le choix de mettre la doc où tu veux

Reply

Marsh Posté le 08-02-2009 à 13:52:35    

J'aurais dit l'inverse, en général, on met la doc dans le source. Même si tu ne livre pas le source, tu peux toujours toi même générer et livrer la doc avec tes binaires.

Reply

Marsh Posté le 08-02-2009 à 15:32:53    

Personnellement je préfère les mettre tant que possible dans les sources. Je n'aime pas surcharger les header. Pour moi un header sert à voir globalement et rapidement l'interface d'une classe, si on rajoute 5-10 lignes de commentaires entre chaque proto, l'information est perdue.
Si l'utililsateur veut une doc de référence la plus complète alors la doc générée est la pour ça, et à plus forte raison quand il n'a pas les sources.
Évidemment, ces considérations dépendent fortement du projet...

Reply

Marsh Posté le 08-02-2009 à 15:41:04    

Pareil, je mets aussi la doc dans le code source, de cette manière, je peux voir rapidement si la doc est à jour par rapport au code, ou ne serait-ce que si la fonction est documenté (ce qui permet d'estimer la marge de modification).

Reply

Marsh Posté le 08-02-2009 à 17:52:27    

+1
Et ça évite de naviguer entre .c et .h pendant qu'on code.


---------------
Les aéroports où il fait bon attendre, voila un topic qu'il est bien
Reply

Sujets relatifs:

Leave a Replay

Make sure you enter the(*)required information where indicate.HTML code is not allowed