Dans cet article, nous en apprendrons davantage sur les commentaires C #, les différents styles de commentaires et pourquoi et comment les utiliser dans un programme.
Les commentaires sont utilisés dans un programme pour nous aider à comprendre un morceau de code. Ce sont des mots lisibles par l'homme destinés à rendre le code lisible. Les commentaires sont complètement ignorés par le compilateur.
En C #, il existe 3 types de commentaires:
- Commentaires sur une seule ligne (
//) - Commentaires sur plusieurs lignes (
/* */) - Commentaires XML (
///)
Commentaires sur une seule ligne
Les commentaires sur une seule ligne commencent par une double barre oblique //. Le compilateur ignore tout après //la fin de la ligne. Par exemple,
int a = 5 + 7; // Ajout de 5 et 7
Voici Adding 5 and 7le commentaire.
Exemple 1: Utilisation d'un commentaire sur une seule ligne
// Hello World Program using System; namespace HelloWorld ( class Program ( public static void Main(string() args) // Execution Starts from Main method ( // Prints Hello World Console.WriteLine("Hello World!"); ) ) )
Le programme ci-dessus contient 3 commentaires sur une seule ligne:
// Programme Hello World // L'exécution commence à partir de la méthode Main
et
// Imprime Hello World
Les commentaires sur une seule ligne peuvent être écrits sur une ligne distincte ou avec les codes sur la même ligne. Cependant, il est recommandé d'utiliser les commentaires sur une ligne distincte.
Commentaires sur plusieurs lignes
Les commentaires sur plusieurs lignes commencent par /*et se terminent par */. Les commentaires sur plusieurs lignes peuvent s'étendre sur plusieurs lignes.
Exemple 2: Utilisation d'un commentaire sur plusieurs lignes
/* This is a Hello World Program in C#. This program prints Hello World. */ using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( /* Prints Hello World */ Console.WriteLine("Hello World!"); ) ) )
Le programme ci-dessus contient 2 commentaires sur plusieurs lignes:
/ * Ceci est un programme Hello World en C #. Ce programme imprime Hello World. * /
et
/ * Imprime Hello World * /
Ici, nous avons peut-être remarqué qu'il n'est pas obligatoire qu'un commentaire sur plusieurs lignes s'étende sur plusieurs lignes. /*… */peut être utilisé à la place des commentaires sur une seule ligne.
Commentaires sur la documentation XML
Le commentaire de documentation XML est une fonctionnalité spéciale de C #. Il commence par une triple barre oblique ///et est utilisé pour décrire catégoriquement un morceau de code… Ceci est fait en utilisant des balises XML dans un commentaire. Ces commentaires sont ensuite utilisés pour créer un fichier de documentation XML distinct.
Si vous n'êtes pas familiarisé avec XML, consultez Qu'est-ce que XML?
Exemple 3: Utilisation du commentaire de documentation XML
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
Le commentaire XML utilisé dans le programme ci-dessus est
/// /// Ceci est un programme Hello World. ///
La documentation XML (fichier .xml) générée contiendra:
Bonjour le monde
Consultez les commentaires de documentation XML si vous souhaitez en savoir plus.
Utilisez les commentaires de la bonne manière
Les commentaires sont utilisés pour expliquer des parties de code, mais ils ne doivent pas être surutilisés.
Par exemple:
// Imprime Hello World Console.WriteLine ("Hello World");
L'utilisation du commentaire dans l'exemple ci-dessus n'est pas nécessaire. Il est évident que la ligne imprimera Hello World. Les commentaires doivent être évités dans de tels cas.
- À la place, des commentaires devraient être utilisés dans le programme pour expliquer des algorithmes et des techniques complexes.
- Les commentaires doivent être courts et précis au lieu d'une longue description.
- En règle générale, il vaut mieux expliquer pourquoi plutôt que comment , en utilisant des commentaires.
