C-SHARP - 2.9 Commentaires

Un commentaire est une indication ajoutée au code pour le rendre plus lisible — pour vous-même et pour les autres développeurs avec qui vous travaillez. Les commentaires sont totalement ignorés par le compilateur : ils n'ont aucun impact sur l'exécution du programme. Beaucoup de développeurs les négligent, alors qu'ils sont essentiels dès qu'on revient sur son code après quelques semaines ou qu'on rejoint un projet en équipe.

Commentaire sur une ligne — //

Dans Visual Studio, placez le curseur sur une ligne et tapez // : tout ce qui suit devient un commentaire, généralement affiché en vert dans la plupart des langages. Un bon commentaire est clair et précis. Il décrit l'intention du code, pas sa mécanique évidente.

// On demande à l'utilisateur d'entrer un nombre
string nombre = Console.ReadLine();

// Conversion des chaînes en entiers et addition
int somme = int.Parse(nombre1) + int.Parse(nombre2);

Commentaire multi-lignes — /* ... */

Pour commenter plusieurs lignes d'un coup, on utilise /* pour ouvrir et */ pour fermer. Pratique pour expliquer une logique complexe ou pour désactiver temporairement un bloc de code pendant des tests.

/*
   Cette section calcule le prix total TTC
   en additionnant les articles et en appliquant
   la TVA de 20%.
*/
  • // : commentaire sur une ligne
  • /* ... */ : commentaire sur plusieurs lignes
  • Aucun impact sur l'exécution du programme
  • Indispensable pour les projets d'équipe et la maintenabilité

Prenez l'habitude de commenter votre code dès le début. À long terme, cela vous fera gagner un temps précieux à vous comme à vos collègues. Rendez-vous dans la prochaine vidéo.

En résumé

Une leçon fondamentale sur les commentaires en C#, expliquant leur utilité pour améliorer la lisibilité du code et faciliter la collaboration en équipe. Le cours présente les deux syntaxes de commentaires en C# : la ligne simple avec // et les blocs multi-lignes avec /* */, en soulignant l'importance de rédiger des commentaires clairs et précis qui aident les développeurs à comprendre la logique du code et à maintenir les projets après une période d'inactivité.

Points clés

  • Un commentaire est une indication dans le code ignorée par le compilateur, utilisée pour clarifier la logique et améliorer la lisibilité du code
  • En C#, les commentaires sur une seule ligne s'écrivent avec // et s'affichent généralement en couleur différente dans l'éditeur
  • Les commentaires multi-lignes en C# utilisent la syntaxe /* */ et permettent d'expliquer du code complexe ou de désactiver temporairement des portions de code
  • Les commentaires sont essentiels en travail d'équipe pour documenter l'intention du code et éviter les malentendus après une longue absence
  • Un bon commentaire doit être clair, précis et utile aux autres développeurs, pas vague ou superflu

Questions fréquentes

Pourquoi les commentaires ne ralentissent pas le programme ?

Parce que le compilateur ignore complètement les commentaires lors de l'exécution du code. Ils n'existent pas pour le programme une fois compilé.

Quelle est la différence entre un commentaire sur une ligne et un commentaire sur plusieurs lignes en C# ?

Un commentaire sur une ligne utilise // et affecte uniquement le texte qui le suit jusqu'à la fin de la ligne. Un commentaire sur plusieurs lignes utilise /* */ et permet de couvrir plusieurs lignes, utile notamment pour désactiver temporairement un bloc de code durant les tests.

Les commentaires sont-ils vraiment importants si le code est clairement écrit ?

Oui, car un commentaire documente l'intention et la logique du code. Il aide les autres développeurs et vous-même (après une absence prolongée) à comprendre rapidement le contexte et les choix de conception.