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

NDoc 支持的属性 (Attribute)

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

NDoc 中的 MSDN 文档引擎和 VS.NET 文档引擎使用了一些 属性 来控制代码文档中一些特殊样式。

如果类型或成员具有以下属性,NDoc 将显示相应的特殊样式,使文档看起来更加专业。

属性 说明

ObsoleteAttribute

标记该类型或成员为“已过时。

FlagsAttribute

指示可以将枚举作为位域(即一组标志)处理,允许按位组合其成员值。

NDoc 将仿照 .NET Framework SDK 文档中处理方式:

  • 在该枚举摘要下面显示“此枚举具有允许按位组合其成员值的 FlagsAttribute 属性。”
  • 在枚举成员的列表中添加“值”列,显示每个枚举成员对应的枚举值。

EditorBrowsableAttribute

使用此属性(attribute)的成员将不显示在 VS.NET 的属性窗口、对象浏览器及智能感知等列表中,根据 NDoc 项目配置中的 EditorBrowsableFilter 配置,NDoc 可以将这部分被隐藏的成员排除在代码文档之外。

注:在 NDoc 1.3 中,我们推荐您使用 <exclude/> XML 文档标记在代码文档中隐藏某些类型或成员。

AssemblyVersionAttribute

根据 NDoc 项目配置中的 AssemblyVersionInfo 配置,NDoc 可以在代码文档中包含通过 AssemblyVersionAttribute 属性指定的程序集版本信息。