h. ou .cc pour les documentations

Re: h. ou .cc pour les documentations

by Ronan Boulic -
Number of replies: 0

La documentation doit se répartir entre le .h et le .cc selon les principes habituels.

-> dans l'interface, le .h, on ne voit que les prototypes des fonctions car leur implémentation doit être externalisée dans l'implémentation. On y décrit seulement le BUT de ces fonctions exportées. Les noms des fonctions et les noms des paramètres devraient suffire (ne pas répéter sous forme de commentaires ce qu'on comprend avec les noms). Il faut préciser par contre le domaine de validité des paramètres s'il y en a un.

Il n'y a pas de longueur maximum pour le fichier .h vis à vis de la documentation mais restez concis pour préserver la clarté de ce fichier.

-> dans l'implémentation, le .cc, on doit trouver les précisions sur COMMENT les fonctions exportées sont mises en oeuvres. Là aussi les noms des variables, champs, attributs, méthodes devraient suffire ; on ajoute des commentaire pour des aspects plus techniques ou des conventions qu'on ne peut pas comprendre en lisant le code.

Dans l'implémentation on trouvera aussi des fonctions utilitaires (static/unnamed namespace) qui ne sont pas exportées dans l'interface. On appliquera la décomposition des commentaires selon les même principes que ci-dessus mais en restant dans caché dans l'implémentation.