<exception> 文档标记

<exception> 标记可用于指定可引发的异常。 这是适用于方法定义的标记。

语法

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

参数

member
对当前编译环境中出现的一个异常的引用。 使用名称查找规则，编译器检查是否存在给定的异常，并将 member 转换为输出 XML 中的规范的元素名称。 如果编译器没有找到 member，它会发出警告。

将名称括在单引号或双引号中。

有关如何创建对泛型类型的 cref 引用的详细信息，请参阅 <see>。

description
说明。

备注

使用 /doc 进行编译以将文档注释处理到文件中。

MSVC 编译器将尝试通过文档注释在一次处理中解析 cref 引用。 如果使用 C++ 查找规则，当编译器找不到符号时，引用将被标记为未解析。 有关详细信息，请参阅 <seealso>。

示例

// xml_exception_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_exception_tag.dll
using namespace System;

/// Text for class EClass.
public ref class EClass : public Exception {
   // class definition ...
};

/// <exception cref="System.Exception">Thrown when... .</exception>
public ref class TestClass {
   void Test() {
      try {
      }
      catch(EClass^) {
      }
   }
};

另请参阅

XML 文档