<exception>(C# 编程指南)
<exception cref="member">description</exception>
参数
cref = "member"
对可从当前编译环境中获取的异常的引用。 编译器检查到给定异常存在后,将 member 转换为输出 XML 中的规范化元素名称。 member 必须位于双引号 (" ") 中。有关如何创建对泛型类型的 cref 引用的更多信息,请参见 <see>(C# 编程指南)。
description
异常说明。
备注
<exception> 标记使您可以指定哪些异常可被引发。 此标记可用在方法、属性、事件和索引器的定义中。
使用 /doc 进行编译可以将文档注释处理到文件中。
有关异常处理的更多信息,请参见异常和异常处理(C# 编程指南)。
示例
// compile with: /doc:DocFileName.xml
/// Comment for class
public class EClass : System.Exception
{
// class definition...
}
/// Comment for class
class TestClass
{
/// <exception cref="System.Exception">Thrown when...</exception>
public void DoSomething()
{
try
{
}
catch (EClass)
{
}
}
}