Commentaires du projet pour rendu

Commentaires du projet pour rendu

par Sophie Sarah Ammann,
Number of replies: 2

Bonjour,

Comment devons-nous commenter les fonctions dans les fichiers *.c prototypées dans les fichiers *.h ? Puisqu'elles leur fonctionnement est décrit dans les *.h, est-ce nécessaire d'ajouter quelque chose ?

D'avance merci 


In reply to Sophie Sarah Ammann

Re: Commentaires du projet pour rendu

par Jonas Blanc,
In reply to Jonas Blanc

Re: Commentaires du projet pour rendu

par Jean-Cédric Chappelier,

En complément :
tout copié-collé (= duplication d'information) est à éviter, même pour les commentaires (toujours la même idée : si on en change un, il ne faut pas que ça nous oblige à en changer un autre). Donc : non pour les commentaires qui sont déjà dans les .h (juste mettre p.ex. « voir .h » ) ; et oui pour tout ce qui est nouveau de votre part **ET** qui nécessite commentaire (trop de commentaire tue le commentaire).