【发布时间】:2013-11-08 07:48:51
【问题描述】:
我继承了一堆 C# 代码。对于几个方法定义,我发现 ///<exclude/> 是它前面唯一的 XMLDoc。我试图用谷歌搜索它的含义,但没有成功。有人可以解释一下这可能意味着什么吗?
【问题讨论】:
标签: c# xml-documentation
我继承了一堆 C# 代码。对于几个方法定义,我发现 ///<exclude/> 是它前面唯一的 XMLDoc。我试图用谷歌搜索它的含义,但没有成功。有人可以解释一下这可能意味着什么吗?
【问题讨论】:
标签: c# xml-documentation
至少在NDoc 中,这意味着应该排除该成员的XML 文档。来自documentation:
<exclude/>标签指示 NDoc 从文档中排除当前项目。
我不清楚这是否最初是特定于 NDoc 的,但 Sandcastle 似乎也支持它(因为它在 Sandcastle XML comments guide 中)。
【讨论】:
来自Sandcastle Help File Builderdocumentation:
命名空间通过命名空间摘要属性或 项目被排除,因为它的 XML cmets 包含
标签。此信息会自动与 API 过滤器合并 设置。要更改这些项目,您需要使用命名空间 汇总属性或从项目的 XML cmets 中删除标记。
官方回复:
A way to exclude documentation?
以及有关行为的更多信息:
【讨论】: