Discussion :

[Gruik]

Hello,

J'ai un collegue qui me fait remarquer que visiblement, ecrire dans le .c la doc des fonctions exportées (celles qu'on trouve dans le .h) est entré dans les moeurs..
J'aimerais avoir vos avis

[Jean-Marc.Bourguet]

La place de la doc des fonctions exportées est dans le .h

[Gruik]

C'est ce qu'on m'a toujours enseigné en effet..
Mais l'utilisation d'un generateur de doc type doxygen ne change t elle pas la donne quand à la fonction documentatrice du .h?

[Jean-Marc.Bourguet]

C'est ce qu'on m'a toujours enseigné en effet..
Mais l'utilisation d'un generateur de doc type doxygen ne change t elle pas la donne quand à la fonction documentatrice du .h?

Doxygen gère aussi bien ce qui est dans le .h que dans le .c. Et de plus, il y a une partie de la doc d'utilisation qui n'a sa place ni dans l'un, ni dans l'autre. Doxygen peut servir à la mettre en forme en la prenant ailleurs (dans des .dox par exemple).

[Shugo78]

Moin on ma toujours dit que la doc des fonctions exportées doit être dans les .h.
Et il ne me semble pas qu'écrire la doc dans les .c soit entré dans les moeurs

[souviron34]

qu'entendez-vous par doc ???

Moi je dirais :

• dans le .c :
  
  
  
  • En tête du fichier : liste des fonctions figurant dans le fichier, classées par scope : local, interne/externe, externe.
    
    
  • fonction (éventuellement algo) documentée pour le programmeur suivant éventuel dans l'entête de la fonction.
    
    
  • Commentaires abondants
  
  
  
• Dans le .h :
  
  
  
  • Une ligne ou 1/2 ligne de commentaire éventuellement
  
  
  
• Pour la doc :
  
  
  
  • Un "man page" soit par fonction soit par module si trop gros.
    
    
  • Un fichier html de documentation complet.

[bi_turbo]

Les variables et les spécifications des fonctions mises en oeuvre dans un module sont regroupés dans un fichier.h

raison pour laquelle on y accede par la directive #include.

En plus c'est le fichier qui pose le moins de problèmes!