Les commentaires, c'est très utile !



Qu'est-ce que ça veut dire "commenter" ?


Cela signifie : taper du texte au milieu de votre programme pour indiquer ce qu'il fait, à quoi sert telle ligne de code etc. C'est vraiment quelque chose d'indispensable car, même en étant un génie de la programmation, on a besoin de faire quelques annotations par-ci par-là. Cela permet :


  •    De vous retrouver au milieu d'un de vos codes sources plus tard. On ne dirait pas comme ça, mais on oublie vite comment fonctionnent les programmes qu'on a écrits ! Si vous faites une pause ne serait-ce que de quelques jours, vous aurez besoin de vous aider de vos propres commentaires pour vous retrouver dans un gros code.
  •    Si vous donnez votre projet à quelqu'un d'autre (qui ne connaît pas à priori votre code source), cela lui permettra de se familiariser avec bien plus rapidement.
  •    Enfin, ça va me permettre à moi de rajouter des annotations dans les codes sources de ce cours. Cela me permettra de mieux vous expliquer à quoi peut servir telle ou telle ligne de code.



Il y a plusieurs manières de rajouter un commentaire. Tout dépend de la longueur du commentaire que vous voulez écrire :


  •    Votre commentaire est court : il tient sur une seule ligne, il ne fait que quelques mots. Dans ce cas, vous devez taper un double slash (//) suivi de votre commentaire. Par exemple :


 




    Vous pouvez aussi bien écrire un commentaire seul sur sa ligne, ou bien à droite d'une instruction. C'est d'ailleurs quelque chose de très pratique car ainsi on sait que le commentaire sert à indiquer à quoi sert la ligne sur laquelle il est. Exemple :


    



    Notez que ce type de commentaire a normalement été introduit par le langage C++, mais vous n'aurez pas de problème en l'utilisant pour un programme en langage C (sauf si vous êtes un puriste ;) )


  •    Votre commentaire est long : vous avez plein de choses à raconter, vous avez besoin d'écrire plusieurs phrases qui tiennent sur plusieurs lignes. Dans ce cas, vous devez taper un code qui signifie "début de commentaire" et un autre code qui signifie "fin de commentaire" :
    •        Pour indiquer le début du commentaire : tapez un slash suivi d'une étoile (/*)
    •        Pour indiquer la fin du commentaire : tapez une étoile suivie d'un slash (*/)



    Vous écrirez donc par exemple :





Reprenons notre code source qui écrit "Bonjour", et ajoutons-lui quelques commentaires juste pour s'entraîner :




Voilà ce que donnerait notre programme avec quelques commentaires

Oui, il a l'air d'être plus gros, mais en fait c'est le même que tout à l'heure. Lors de la compilation, tous les commentaires seront ignorés. Ces commentaires n'apparaîtront pas dans le programme final, ils servent seulement aux programmeurs.



Le mieux est de commenter plusieurs lignes à la fois, c'est-à-dire d'indiquer à quoi sert une série d'instructions histoire d'avoir une idée. Après, si le programmeur veut se pencher plus en détail dans ces instructions, il est assez intelligent pour y arriver tout seul.


Retenez donc : les commentaires doivent guider le programmeur dans son code source, lui permettre de se repérer. Essayez de commenter un ensemble de lignes plutôt que toutes les lignes une par une.


Citation : Règle de la maison IBM

Si après avoir lu uniquement les commentaires d'un programme vous n'en comprenez pas le fonctionnement, jetez le tout !

Créé avec HelpNDoc Personal Edition: Générateur d'aide complet