Commentaires en C#

Qu'est-ce qu'un commentaire ?

Dans le domaine de la programmation, un commentaire est une portion de texte qui ne s'exécute pas dans le programme. Il est essentiel pour fournir des explications, des annotations, ou des notes qui permettent aux autres développeurs, ou à vous-même plus tard, de mieux comprendre le code.

Commentaire sur une seule ligne

Pour les commentaires d'une seule ligne, le compilateur ignore tout texte situé après deux barres obliques consécutives (//) sur la même ligne. Voici un exemple :

// Ceci est un commentaire sur une seule ligne
Console.WriteLine("Bonjour tout le monde!"); // Affichage d'un message

Commentaire multi-lignes

Les commentaires multi-lignes commencent par / et se terminent par /. Le texte situé entre ces balises sera également ignoré par le compilateur. Exemple :

/*
Ceci est un commentaire multi-ligne.
Rien de cela ne sera exécuté !
*/

Commentaires XML

Les commentaires XML sont des commentaires structurés qui génèrent de la documentation API. Le compilateur C# produit un fichier XML contenant les données structurées des commentaires. D'autres outils peuvent alors interpréter ce fichier XML afin de créer de la documentation lisible par l'homme, comme des pages web ou des fichiers PDF.

Syntaxe : Un commentaire XML sur une ligne est écrit avec trois barres obliques :

/// Ceci est un commentaire XML

Un commentaire XML multi-ligne se présente de manière similaire, sauf qu'un astérisque supplémentaire (*) est utilisé au début :

/**
Ceci est un commentaire XML multi-ligne.
*/

Exemple de balise XML

Les balises XML intégrées dans les commentaires XML sont utilisées pour signaler une fonctionnalité spécifique. Par exemple, la balise

décrit une classe ou une méthode. Voici un exemple :

/// 

/// Cette classe effectue une fonction importante.
/// 
public class MaClasse {}