在 C# XML 文档注释中使用 <param> 和 <paramref> 标签

2018-08-08 08:00:00 · 飞浪

介绍代码文档描述了软件代码的意图。其中包括类及其成员的意图或描述、参数和预期结果或返回值。XML代码文档必须紧接在用户定义类型（例如类、接口或委托）或其成员（例如字段、属性、方法或事件

介绍

代码文档描述了软件代码的意图。其中包括类及其成员的意图或描述、参数和预期结果或返回值。XML 代码文档必须紧接在用户定义类型（例如类、接口或委托）或其成员（例如字段、属性、方法或事件）之前。Visual Studio 和 VS Code 的 IntelliSense 功能可以利用文档注释来显示有关类型或成员的信息；这些信息来自您在代码文档中输入的内容。

XML 文档以///开头，可以包含为注释赋予特殊含义的推荐标签。其中两个推荐标签是<param>和<paramref>，我们将在本指南中介绍它们。

<paramref>标签用于表示某个单词是参数。有时，您可能在<summary>或<remarks>标签中描述某个方法的作用，并且希望在描述中引用某个参数。这时可以使用<paramref>标签。这样，如果您为项目生成 XML 文档文件，则可以处理此文件以采用不同的方式格式化该单词。

将其应用于Add方法将如下所示：

      /// <summary>This method adds <paramref name="operand1"/> and <paramref name="operand2"/>.</summary>
  /// <param name="operand1">the left side operand.</param>
  /// <param name="operand2">the right side operand.</param>
  static int Add(int operand1, int operand2)
  {
    return operand1 + operand2;
  }
    

与<param>标签类似，name属性是与<summary>标签内的描述一起显示的参数名称。

包起来

文档注释对于帮助您或使用您代码的其他程序员更好地理解您的代码非常有用。在我们的示例中，代码表明第一个参数将用作左侧操作数，这有助于说明该方法如何进行计算。尽可能多地使用 XML 文档，并为您的代码赋予更多含义。请参阅 C# 文档以了解更多推荐的标签。

_{免责声明：本内容来源于第三方作者授权、网友推荐或互联网整理，旨在为广大用户提供学习与参考之用。所有文本和图片版权归原创网站或作者本人所有，其观点并不代表本站立场。如有任何版权侵犯或转载不当之情况，请与我们取得联系，我们将尽快进行相关处理与修改。感谢您的理解与支持！}

_查看原文

技术指南

阅读全文

在 C# XML 文档注释中使用 <param> 和 <paramref> 标签

杭州电子商务研究院

6年前 · 面向社会、服务行业、政产学研结合、整合资源、和谐发展

/// <param name="operand1">the left side operand.</param> /// <param name="operand2">the right side operand.</param> static int Add(int operand1, int operand2) { return operand1 + operand2; }

/// <summary>This method adds <paramref name="operand1"/> and <paramref name="operand2"/>.</summary> /// <param name="operand1">the left side operand.</param> /// <param name="operand2">the right side operand.</param> static int Add(int operand1, int operand2) { return operand1 + operand2; }