在 C# XML 文档注释中使用 <exception> 标签

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

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

介绍

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

XML 文档注释以///开头，可以包含为注释赋予特殊含义的推荐标签。其中一个推荐标签是<exception>，我们将在本指南中讨论它。

标签实际作用

<exception>提供了一种方法来记录方法、属性、事件和索引器可能引发的异常。它可以写成如下形式：

      <exception cref="member">description</exception>

cref属性包含对异常的引用。在标记之间，您将用对抛出异常的情况的描述替换description 。让我们看看以下代码定义：

      class Program
{
  private static int _age;

 static void Main(string[] args)
 {
   Console.WriteLine("Hello World!");
   Age = 14;
 }

 /// Client's Age
 /// <exception cref="System.ArgumentException">Thrown when age is set to be less than 18 years.</exception>
 /// <exception cref="System.ArgumentOutOfRangeException">Thrown when age is set to be more than 70 years.</exception>
 static int Age
 {
   get
   {
   return _age;
   }
   set
   {
   if (_age < 18)
   {
     throw new System.ArgumentException("You must be older than 17");
   }
   if (_age > 70)
   {
     throw new System.ArgumentOutOfRangeException("You can't be older than 70");
   }

   _age = value;
   }
 }
}
    

上面，我们有一个Age属性，当它被设置为小于 18 岁或大于 70 时，它会抛出异常。cref属性保存对抛出的异常的引用，而错误抛出的描述则放在标签之间。当其他人使用您的代码时，此信息很有价值，这样他们就可以知道将此属性设置为什么才能不出现异常。当您访问此属性或将鼠标悬停在其上时，IntelliSense 可以显示此信息。

包起来

XML 文档注释对于帮助您或将使用您的代码的其他程序员更好地理解代码非常有用。我们查看了推荐的<exception>标签，它提供了一种记录方法、属性、事件或索引器可能引发的异常的方法。您了解了我们如何通过 IntelliSense 查看此信息。

尽可能多地使用 XML 文档注释，让代码更有意义。请参阅 C#文档以获取更多推荐的标签。

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

_查看原文

技术指南

阅读全文

在 C# XML 文档注释中使用 <exception> 标签

杭州电子商务研究院

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

class Program { private static int _age; static void Main(string[] args) { Console.WriteLine("Hello World!"); Age = 14; } /// Client's Age /// <exception cref="System.ArgumentException">Thrown when age is set to be less than 18 years.</exception> /// <exception cref="System.ArgumentOutOfRangeException">Thrown when age is set to be more than 70 years.</exception> static int Age { get { return _age; } set { if (_age < 18) { throw new System.ArgumentException("You must be older than 17"); } if (_age > 70) { throw new System.ArgumentOutOfRangeException("You can't be older than 70"); } _age = value; } } }