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

<event>

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

<event> 标记用于说明被标记的方法可能引发的事件。Section 标记。

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

其中:

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

应用于

方法成员。

备注

 

示例

请参见

标记用法 | NDoc 支持的标记