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

可用 Section 的列表

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

可用 Section 的列表

下面列出了所有可用 section 的清单,它们用于 NDoc 扩展 XSLT 转换模板中 mode 属性的值,指示该标记将显示在代码文档中的区域。

Section 名称 说明
header-section HTML 的 HEAD 区域。可以使用此区域添加附加的样式定义等。
preliminary-section “预发布”警告区域。仅当注释文档中使用 <preliminary> 标记显式标出,或通过文档引擎的 Preliminary 配置为 true 时,才会显示该区域。
summary-section <summary> 标记对应的区域。tag.
thread-safety-section “线程安全”区域。
syntax-section “语法”区域。
value-section <value> 标记对应的“属性值”区域。
parameter-section <param> 标记对应的“参数”区域。
returnvalue-section <returns> 标记对应的“返回值”区域。
implements-section “接口实现”区域。
remarks-section <remarks> 标记对应的“备注”区域。
after-remarks-section “备注”区域后的区域。

注意: 不管“备注”区域是否存在,此区域总是存在的。

obsolete-section “已过时”区域。
events-section <event> 标记对应的“事件”区域。
exceptions-section <exception> 标记对应的“异常”区域。
example-section <example> 标记对应的“示例”区域。
member-requirements-section (某一个成员的)“要求”区域。
type-requirements-section (类型的)“要求”区域。
seealso-section “请参见”区域。
enumeration-members-section “枚举成员”区域。
footer-row 页脚区域。
title-row 页眉区域。
overloads-remarks-section 重载页面的“备注”区域。
overloads-example-section 重载页面的“示例”区域。
overloads-summary-section 重载页面的“摘要”区域。
xml-data-island HTML 页头部嵌入的 XML 数据区域,可以附加自定义的元素或内容。 仅对 VS.NET 2003 文档引擎有效。

请参见

NDoc 可扩展性