[Kos-dev] Commentaires des fonctions

[Thomas Petazzoni]

Salut,

Il faudrait se décider sur comment on fait les commentaires des
fonctions. On est parti pour doxygen, là dessus on est d'accord. Là où
d2 et moi ne sommes pas d'accord, c'est sur la position des commentaires
:
 * moi, je les préfère au dessus de chaque fonction dans le .c. Ça
permet de documenter en même temps les fonctions "publiques" et/ou
"exportées" ainsi que les fonctions interne. Le source C est donc
agréable à lire. Il faut savoir que doxygen récupère directement dans le
.c le commentaire de chaque fonction si il n'est pas présent dans le .h
correspondant.

 * d2 les préfère dans le .h. Ça présente l'avantage d'avoir une sorte
de documentation dans le .h. En revanche, je trouve personnellement
assez laid d'avoir des fonctions commentées dans le .C (les fonctions
internes), d'autres dans le .h (les fonctions publiques). D'autre part,
ça ferait dans le .c qu'il y aurait des fonctions non commentées,
d'autres si. 

Voilà le dilemme !

Thomas
-- 
PETAZZONI Thomas - thomas.petazzoni at enix.org 
http://thomas.enix.org - Jabber: kos_tom at sourcecode.de
KOS: http://kos.enix.org/ - Lolut: http://lolut.utbm.info
Fingerprint : 0BE1 4CF3 CEA4 AC9D CC6E  1624 F653 CB30 98D3 F7A7
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
Url : http://the-doors.enix.org/pipermail/kos-dev/attachments/20040103/7332c416/attachment.pgp