C# 注释作用写法及示例代码

1、注释作用

注释可用于解释C# 代码，并使其更具可读性。在测试备用代码时，它也可用于阻止执行。

单行注释以两个斜杠（//）开头。

C#将忽略//与行结尾之间的所有文本。

本示例在一行代码之前使用单行注释：

例如：

// 注释内容用来解释说明代码
Console.WriteLine("Hello World!");

本示例在代码行的末尾使用单行注释：

例如：

Console.WriteLine("Hello World!");// 注释内容用来解释说明代码

2、C# 多行注释

多行注释以/*开头，以*/结尾。

C#将忽略/*和*/之间的任何文本。

本示例使用多行注释（注释块）来解释代码：

例如：

/* 注释内容是用来
 * 解释说明代码 
 */ 
Console.WriteLine("Hello World!");

单行或多行注释

确定使用哪种注释。 通常，我们使用//进行简短注释，使用/ * * /进行较长注释。

public class HelloWorld {
   /* 这是第一个C#程序
    * 它将输出 Hello World
    * 这是一个多行注释的示例
    */
       static void Main(string[] args)
    {
       // 这是单行注释的示例
       /* 这个也是单行注释的示例 */
       Console.WriteLine("Hello World!");
    }
}

3、文档注释 (///)

用于生成 XML 文档，适用于类、方法、属性等代码的详细说明。在 IDE（如 Visual Studio）中，使用 /// 时，自动生成标准注释格式。适用于 API 文档的自动生成。

using System;

class Program
{
    /// <summary>
    /// 计算两个整数的和
    /// </summary>
    /// <param name="a">第一个整数</param>
    /// <param name="b">第二个整数</param>
    /// <returns>返回两个整数的和</returns>
    static int Add(int a, int b)
    {
        return a + b;
    }

    static void Main()
    {
        int result = Add(5, 3);
        Console.WriteLine("Sum: " + result);
    }
}

<summary>方法的简要说明。<param>描述方法的参数。<returns>描述返回值。在 Visual Studio 中，当输入 /// 并回车，它会自动生成 XML 文档格式，帮助团队成员更清晰地理解代码。