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

<see>

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

<see> 标记用于在行文中添加一个超链接。

<see cref="member">[label]</see>

<see href="URL">[label]</see>

<see langword="null | sealed 
| static | abstract | virtual | true | false"/>

其中:

label
超链接的显示文本。
cref = "member"
表示要链接到的类型(成员)。书写时,如果要链接到的类型(成员)是同一命名空间(类型)中的类型(成员),member 可以直接写它的名称(注意大小写);如果是其他命名空间(类型)的,建议您写该类型(成员)的完全限定名称。C# 编译器将检查该类型(成员)是否存在。在输出的 XML 文档文件中,C# 编译器会自动转换简写的 member 为完全限定名称。
href = "URL" [NDoc 扩充]
一个网络 URL 地址。
langword [NDoc 扩充]
将会被当作 .NET 关键字粗体显示。如果 langword 是下面备注中的表格里的某个关键字,还将会被替换为相应的说明文本。

应用于

可用于其他标记内部。

备注

使用 <seealso> 标记将超链接加入到页面的“请参见”区域。

注意: 在 NDoc 1.3 中,对于 MSDN 和 VS.NET 文档引擎,如果一个区域出现了多个指向同一个类型/成员的文档的 <see>,则只转换第一个为超链接,其余的不表示为超链接、只显示为粗体。这将使页面不至于太杂乱。

可识别的 langword

如果 langword 为下表中的关键字之一,则会显示右侧相应的说明文本。

langword 显示
null 空引用(Visual Basic 中为 Nothing)
sealed 密封的(Visual Basic 中为 NotInheritable)
static 静态(Visual Basic 中为 Shared)
abstract 抽象(Visual Basic 中为 MustInherit)
virtual 虚拟(Visual Basic 中为 CanOverride)

示例

请参见 <summary> 中的示例。

请参见

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