Les langages de programmation proposent une notation pour insérer des commentaires dans le code, c'est-à-dire du texte qui va être ignoré par l'ordinateur. Les commentaires peuvent servir à expliquer une partie compliquée d'un programme, ou à mettre des indications dans le code, comme son auteur ou sa date.


Le langage de programmation utilisé est le C++.


Tout ce qui se trouve après « // » (barre oblique ou slash en anglais)  sera un commentaire.

On peut aussi  encadrer des commentaires sur plusieurs lignes entre « /* » et « */ ».



Voici un exemple :


/*

  Ce programme a été écrit par GCworks

  Affiche un rectangle rempli de X

*/


void setup() {

  // écrire ici le code d'initialisation, exécuté une seule fois

  pinMode(LED_BUILTIN, OUTPUT);

}


void loop() {

  // écrire ici le code principal, exécuté en boucle

  digitalWrite(LED_BUILTIN, HIGH);  // allume la DEL

  delay(1000);                      // temporisation de 1 seconde

}


La priorité est toujours d'écrire le code le plus clair possible. Il est très souvent bien plus efficace de comprendre un programme directement à partir de ses instructions, qu'en alternant la lecture des instructions avec celle d'explications spécifiques. 

N'utilisez donc de commentaires que lorsque cela s'avère nécessaire, une fois que vous avez travaillé la clarté de votre code au maximum.

























Créé avec HelpNDoc Personal Edition: Produire des livres électroniques facilement