Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

Bien commenter et documenter son code en c

Bien commenter et documenter son code en C Date de publication octobre Date de mise à jour octobre Par Lainé Vincent autres articles Ce tutoriel à pour but de donner quelques règles simples afin de bien commenter et documenter son code en C I Introduction II Commenter le code II-A Que faut -il commenter dans le code II-B Comment le commenter II-C Conclusion sur les commentaires III Documenter le code III -A Documenter oui mais comment III -B Les tags de documentations III -B- Le tag summary III -B- L e tag param III -B- Le tag returns III -B- Le tag value III -B- Le tag paramref III -B- Le tag c III -B- Le tag remarks III -B- Le tag exception III -B- Le tag example III -B- Le tag code III -B- Le tag see III -B- Le tag seealso III -B- Le cas des listes III -C Comment générer la documentation III -C- Génération de la documentation avec NDoc IV Remerciement V Liens utiles I Introduction Compatible avec La lecture de ce tutoriel ne requiert aucune connaissance particulière si ce n'est les bases de la programmation en C Tout au long de ce tutoriel je m'enfforcerai de faire la distinction entre ce qui est admis par tous et les règles que j'applique moi même L'idée de ce tutoriel vient d'un sujet de discussion sur le forum Je tiens également à préciser que les exemples de code sont volontairement simplistes et parfois un développeur expérimenté ne trouvera pas les commentaires pertinents toutefois le tutoriel vise un pu blic débutant Tout les mots entre du tutoriel sont des tags de documentation Tout les mots en gras sont des mots clefs du langage et tous les mots en italique sont des arguments des tags de documentation II Commenter le code Commenter le code Tout le monde en a entendu parler les développeurs chefs de projets professeurs le disent tout le temps Commente ton code STP Mais voilà que faut -il commenter Comment le commenter C'est à ces deux principales questions que je vais essayer de répondre II -A Que faut -il commenter dans le code Assurément il ne faut pas tout commenter dans un code C'est d'ailleurs un des problèmes rencontrés assez régulièrement quand l'on travaille en équipe soit le code n'est pas du tout commenté soit il l'est trop Sachez que dans les deux cas le résultat est le même le code est illisible Afin d'avoir un code facilement lisible par une tierce personne ou par soi -même d'ailleurs il faut donc le commenter de manière intelligent e c'est à dire ni trop ni pas assez et avec précision Exemple public void Main string args Lancement Application Run new MainForm Ceci est un exemple parfait de ce qu'il ne faut pas faire Le commentaire est imprécis et inutile Dans un cas comme ça je préfére laisser au développeur le soin de chercher dans la documentation du framework à quoi sert Application Run et comment l'on s'en sert De