Commentaires C#
Commentaires C#
Dans cet article, nous découvrirons 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 multi-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 // jusqu'au bout de la ligne. Par exemple,
int a = 5 + 7; // Adding 5 and 7
Ici, Adding 5 and 7 est le 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 d'une seule ligne :
// Hello World Program // Execution Starts from Main method
et
// Prints Hello World
Les commentaires sur une seule ligne peuvent être écrits sur une ligne séparée ou avec les codes sur la même ligne. Cependant, il est recommandé d'utiliser les commentaires sur une ligne séparée.
Commentaires sur plusieurs lignes
Les commentaires sur plusieurs lignes commencent par /* et se termine par */ . Les commentaires multi-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 :
/* This is a Hello World Program in C#. This program prints Hello World. */
et
/* Prints Hello World */
Ici, nous avons peut-être remarqué qu'il n'est pas obligatoire qu'un commentaire multi-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 séparé.
Si vous n'êtes pas familier avec XML, consultez Qu'est-ce que XML ?
Exemple 3 :Utilisation d'un commentaire de documentation XML
/// <summary>
/// This is a hello world program.
/// </summary>
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
/// <summary> /// This is a hello world program. /// </summary>
La documentation XML (fichier .xml) générée contiendra :
<?xml version="1.0"?> <doc> <assembly> <name>HelloWorld</name> </assembly> <members> </members> </doc>
Consultez les commentaires de la 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 :
// Prints Hello World
Console.WriteLine("Hello World"); L'utilisation de commentaire dans l'exemple ci-dessus n'est pas nécessaire. Il est évident que la ligne affichera Hello World. Les commentaires doivent être évités dans de tels cas.
- Les commentaires doivent plutôt ê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 est préférable d'expliquer pourquoi au lieu de comment , à l'aide de commentaires.
Langue C