Commenter un bloc de texte en C#

1. Commentaires sur une seule ligne et sur plusieurs lignes pour un bloc de texte en C#
2. Commenter un bloc de texte en C# avec la fonctionnalité de sélection de boîte de Visual Studio
3. Commenter un bloc de texte avec un espace ou un retrait en C#

Les commentaires en tant qu’annotations sont à un niveau d’abstraction plus élevé et sont ignorés par les compilateurs lors de la compilation de votre code C#. Dans ce guide, vous apprendrez différentes méthodes, syntaxes et raccourcis clavier pour commenter un bloc de texte ou de code en C#.

Commentaires sur une seule ligne et sur plusieurs lignes pour un bloc de texte en C#

La ligne unique est le type de commentaire le plus courant en C#. Le compilateur C# ignore tout après une double barre oblique ou // (qui représente un commentaire sur une seule ligne) jusqu’à la fin de la ligne.

Les commentaires multi-lignes commencent par /* et se terminent par /*, et chaque ligne de texte entre eux agira comme un bloc de commentaires.

// This is a single-line comment
// This is another line of comment

using System;

public class SingleLine {
  public static void Main(string[] args) {
    /*
              This will be a comment line.
              This feature is useful for commenting on multiple lines of code at once in C#
    */
    Console.WriteLine("Hello World!");
  }
}

Production:

Hello World!

Techniquement, vous pouvez écrire des commentaires sur plusieurs lignes en utilisant de nombreux commentaires sur une seule ligne. Si vous avez plusieurs lignes de texte à commenter en C#, utilisez Ctrl+E+C pour commenter ces multiples lignes.

Comme raccourci, vous pouvez utiliser Ctrl+K pour commenter et Ctrl+C pour décommenter les lignes de texte sélectionnées en C#. Alternativement, Ctrl+K peut commenter, et Ctrl+U peut décommenter les lignes sélectionnées de code C#.

Commenter un bloc de texte en C# avec la fonctionnalité de sélection de boîte de Visual Studio

Visual Studio dispose d’une fonctionnalité Box Selection lors de l’édition multiligne en C#. Taper avec sélection de boîte vous permet d’insérer un nouveau texte dans chaque ligne du commentaire ou du code.

Vous pouvez sélectionner une zone de texte rectangulaire avec une souris ou un clavier et appuyer sur Alt pour activer la fonction Box Selection.

Placez le pointeur de la souris sur le texte et maintenez la touche Alt enfoncée. Sélectionnez une région rectangulaire avec le bouton gauche de la souris ou à l’aide des touches fléchées du clavier tout en maintenant la touche Alt enfoncée.

Relâchez le bouton gauche de la souris et la touche Alt pour insérer du texte dans chaque ligne du bloc de commentaire sélectionné à la fois.

Avant de:

int First;
int Second;
int Third;

Utilisez Ctrl+E+C pour commenter plusieurs lignes de code à la fois et tapez Ligne de code après avoir sélectionné int dans chaque ligne à l’aide de la fonction Sélection de la boîte.

Après:

// Line of Code First
// Line of Code Second
// Line of Code Third

La fonction Box Selection permet aux développeurs d’ajouter du texte à plusieurs lignes d’un bloc de commentaires à la fois. La fonction Box Selection permet de faire une sélection verticale de zéro caractère pour créer un point d’insertion multiligne pour le texte nouveau ou copié.

Commenter un bloc de texte avec un espace ou un retrait en C#

Lorsque vous commentez un bloc de texte en utilisant Ctrl+E+C après avoir sélectionné quelques lignes de code en utilisant Ctrl+K, C, vous obtenez :

// First line
// Second line
// Third line

Pour insérer un espace ou un retrait entre // et le texte d’un commentaire, déplacez le curseur sur la première ligne après //. Appuyez ensuite sur Alt+Shift et utilisez les touches fléchées haut et bas du clavier pour sélectionner un bloc de texte.

Une fois la sélection terminée, appuyez sur la barre d’espace pour saisir un espace (retrait) dans un bloc de commentaire, et vous obtiendrez :

// First line
// Second line
// Third line

Ces raccourcis clavier sont introduits dans le cadre de Visual Studio 2010 et sont valables pour les versions ultérieures de VS, y compris Visual Studio 2022 IDE.

Alternativement, le commentaire multiligne /* avant la première ligne d’un bloc de texte et */ après la dernière ligne d’un bloc de texte élimine le besoin d’espace ou de retrait.

/*
  First line
  Second line
  Third line
*/

Dans ce tutoriel, vous avez appris toutes les méthodes pour commenter un bloc de texte ou de code en C#. Chaque méthode offre des avantages uniques pour différents scénarios.

Utilisez votre jugement et votre expérience pour décider quelle méthode vous sera la plus utile.