迹忆客 专注技术分享

作为注解的注释处于更高的抽象级别，编译器在编译 C# 代码时会忽略它。在本指南中，你将学习在 C# 中对文本或代码块进行注释的不同方法、语法和键盘快捷键。

C# 中文本块的单行和多行注释

单行是 C# 中最常见的注释类型。C# 编译器会忽略双正斜杠或//（表示单行注释）之后的所有内容，直到行尾。

多行注释以/*开头，以*/结尾，它们之间的每一行文本都将充当一个注释块。

// 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!");
  }
}

输出：

Hello World!

从技术上讲，你可以通过使用许多单行注释来编写多行注释。如果在 C# 中有多行要注释的文本，请使用 Ctrl+E+C 注释掉这些多行。

作为快捷方式，你可以使用 Ctrl+K 来注释和 Ctrl+C 取消注释 C# 中选定的文本行。或者，Ctrl+K 可以注释，Ctrl+U 可以取消对 C# 代码的注释。

使用 Visual Studio 的框选择功能在 C# 中注释文本块

在 C# 中执行多行编辑时，Visual Studio 具有框选择功能。使用框选择键入允许你在注释或代码的每一行中插入新文本。

你可以使用鼠标或键盘选择一个矩形文本区域，然后按 Alt 激活 Box Selection 功能。

将鼠标指针放在文本上并按住 Alt 键。按住 Alt 键的同时使用鼠标左键或从键盘的箭头键选择一个矩形区域。

释放鼠标左键和 Alt 键，一次在所选注释块的每一行中插入文本。

前：

int First;
int Second;
int Third;

使用 Ctrl+E+C 一次注释多行代码，然后在每行选择 int 后键入 Line of Code 使用框选择功能。

后：

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

Box Selection 功能使开发人员可以一次将文本添加到评论块的多行中。框选择功能有助于使垂直选择零字符宽，为新的或复制的文本创建多行插入点。

在 C# 中用空格或缩进注释文本块

当你用Ctrl+E+C选择一些代码行后，用Ctrl+K, C注释一个文本块，你会得到。

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

要在 // 和注释文本之间插入空格或缩进，请将光标移动到 // 之后的第一行。然后按 Alt+Shift 并使用键盘上的向上和向下箭头键选择一个文本块。

选择完成后，按空格键在注释块中输入空格（缩进），你将得到：

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

这些键盘快捷键是作为 Visual Studio 2010 的一部分引入的，适用于更高版本的 VS，包括 Visual Studio 2022 IDE。

或者，在文本块的第一行之前和文本块的最后一行之后的多行注释 /* 消除了对任何空格或缩进的需要。

/*
  First line
  Second line
  Third line
*/

在本教程中，你学习了在 C# 中对文本或代码块进行注释的所有方法。每种方法都为不同的场景提供了一些独特的好处。

用你的判断和经验来决定哪种方法对你有好处。