Forum |  HardWare.fr | News | Articles | PC | S'identifier | S'inscrire | Shop Recherche
3444 connectés 

  FORUM HardWare.fr
  Programmation
  C

  Documenter ses sources avec Doxygen

 


 Mot :   Pseudo :  
 
Bas de page
Auteur Sujet :

Documenter ses sources avec Doxygen

n°1848438
thechief
Posté le 07-02-2009 à 20:02:49  profilanswer
 

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

mood
Publicité
Posté le 07-02-2009 à 20:02:49  profilanswer
 

n°1848578
sligor
Posté le 08-02-2009 à 13:37:13  profilanswer
 

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

n°1848582
matafan
Posté le 08-02-2009 à 13:52:35  profilanswer
 

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.

n°1848602
Jux_
Posté le 08-02-2009 à 15:32:53  profilanswer
 

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...

n°1848606
tpierron
Posté le 08-02-2009 à 15:41:04  profilanswer
 

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).

n°1848641
el muchach​o
Comfortably Numb
Posté le 08-02-2009 à 17:52:27  profilanswer
 

+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

Aller à :
Ajouter une réponse
  FORUM HardWare.fr
  Programmation
  C

  Documenter ses sources avec Doxygen

 

Sujets relatifs
Créer un graphique avec des données sources variablesRecherche developpeur pour recompiler sources VB 6?
Creation d'une table 'sources'Programme pour afficher les sources d'une liste d'url
Code sources Prog objet ou les trouver[XSLT] Générer une documentation "javadoc/doxygen"-like
Compiler sources java: trouve pas le javac.exeSVN, Controle des sources sur hebergeur mutualisé
Sources de la JConsole (jdk 1.6)Compresser / compacter sources Javascript
Plus de sujets relatifs à : Documenter ses sources avec Doxygen


Copyright © 1997-2025 Groupe LDLC (Signaler un contenu illicite / Données personnelles)