NDoc 用户指南   [回目录] NDoc 1.3

<exception>

[此文档为预发布版本,在未来版本中有可能改变。]

<exception> 标记用于说明一个成员可能抛出的异常。

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

其中:

cref = "member"
表示可能抛出的异常类型。书写时,如果可能抛出的异常是同一命名空间下的异常类型,member 可以直接写异常名称(注意大小写);如果是其他命名空间的,建议您写该异常类型的完全限定名称。C# 编译器将检查该异常是否存在。在输出的 XML 文档文件中,C# 编译器会自动转换简写的 member 为完全限定名称。
description
说明信息,比如在什么情况下抛出该异常。

应用于

属性, 方法, 事件, 运算符, 类型转换

备注

示例

[C#]
using System;

/// comment for class
public class EClass : Exception 
{
   // class definition ...
}

class TestClass 
{
   /// <exception cref="EClass">Thrown when... .</exception>
   public static void Main() 
   {
      ...
      throw new EClass();
      ...
   }
}

请参见

标记用法 | NDoc 支持的标记 | Microsoft 的定义