La doc dans le .c

Citation:

---

Envoyé par Jean-Marc.Bourguet

Comment est-ce que tu peux ecrire une fonction publique sans savoir par avance quelle va etre sa doc? Dans ma pratique on concoit d'abord l'interface d'un module, -- ie on ecrit l'entete et la doc d'utilisation. Une fois que tout le monde (y compris les utilisateurs) est d'accord, on implemente.

---

+2

Citation:

---

Envoyé par muad'dib

Un bon compromis serait de mettre la doc dans les fichiers d'entêtes uniquement pour les fonctions publiques, pour expliquer comment les utiliser aux utilisateurs. La doc de l'implémentation quant à elle pourrait être constituée de la doc du .h complétée d'une documentation destinée aux autres programmeurs.

---

Bah, de toutes façons, dans les entêtes publiques, par définition, il n'y a des prototypes que de fonctions publiques... Je ne ne comprends pas l'objet de cette discussion. Il suffit d'un peu de bon sens et on se rend compte qu'elle n'a pas lieu d'être...

A lire d'urgence :

http://emmanuel-delahaye.developpez.com/codage.htm

Citation:

---

Envoyé par Jean-Marc.Bourguet

Comment est-ce que tu peux ecrire une fonction publique sans savoir par avance quelle va etre sa doc? Dans ma pratique on concoit d'abord l'interface d'un module, -- ie on ecrit l'entete et la doc d'utilisation. Une fois que tout le monde (y compris les utilisateurs) est d'accord, on implemente.

---

C'est pas moi qui faut engueuler :aie:

Je savais ça, j'y ai pas pensé quand j'ai posté

Citation:

---

Envoyé par Emmanuel Delahaye

Bah, de toutes façons, dans les entêtes publiques, par définition, il n'y a des prototypes que de fonctions publiques... Je ne ne comprends pas l'objet de cette discussion. Il suffit d'un peu de bon sens et on se rend compte qu'elle n'a pas lieu d'être...

---

+10

Je ne comprends vraiment pas où on vous a appris ou dit qu'il fallait mettre la doc dans les .h ...

Ayant très fortement l'habitude des OS unixoides, mais aussi de VMS, la doc est TOUJOURS à part... (man pages, et éventuellement un .html avec) et dans le .c, mais certainment pas dans le .h.

Ce que j'ai le plus appris avec les OS unixoïdes, c'est "No manual entry for [la-fonction-que-je-cherche]".
C'est pourquoi je trouve que c'est pas mal d'avoir la liste des fonctions publiques et leur aide directement dans les headers...

Citation:

---

Envoyé par Médinoc

Ce que j'ai le plus appris avec les OS unixoïdes, c'est "No manual entry for [la-fonction-que-je-cherche]".
C'est pourquoi je trouve que c'est pas mal d'avoir la liste des fonctions publiques et leur aide directement dans les headers...

---

man -k ???