C#的XML两种代码注释实例说明

C# 有两种类型的 XML 注释：普通注释和特殊注释。

普通注释

在 C# 中，普通注释以双斜线“//”开头，后面跟着注释内容。

普通注释不会自动生成 XML 文档。它们只是代码中的注释，只会被程序员看到。

以下是普通注释的示例：

//这是一个普通注释
int x = 10;

特殊注释

特殊注释以三个斜线“///”开头，后面跟着 XML 标记。特殊注释会在编译时自动抽取，生成 XML 格式的帮助文档。

特殊注释包含一组注释标记，每个标记都以“<”字符开始。

以下是特殊注释的示例：

/// <summary>
/// 这是一个特殊注释
/// </summary>
/// <param name="x">这是参数 x 的说明</param>
/// <returns>这是返回结果的说明</returns>
int MyMethod(int x)
{
    return x;
}

在上述代码中，<summary> 标记用于提供方法的概述，<param> 标记用于为方法的参数提供说明，<returns> 标记用于为方法的返回值提供说明。

下面是另一个使用特殊注释的示例：

/// <summary>
/// 该方法将两个整数相加。
/// </summary>
/// <param name="x">第一个整数</param>
/// <param name="y">第二个整数</param>
/// <returns>返回两个整数的和</returns>
public int Add(int x, int y)
{
    return x + y;
}

在上述代码中，我们使用 <summary>，<param> 和 <returns> 标记提供了该方法的描述，以及它的参数和返回值的说明。

使用特殊注释，可以帮助其他人更好地理解你的代码，并且也可以自动生成规范的文档，方便其他人查看和使用你的代码。