“/// <exclude>”是什么意思?</exclude>

时间:2013-10-29 08:44:21

标签: c# xml-documentation

我继承了一堆C#代码。对于几个方法定义,我发现///<exclude/>是它前面唯一的XMLDoc。我试图谷歌的意思,但没有成功。有人可以解释一下这可能意味着什么吗?

2 个答案:

答案 0 :(得分:14)

至少在NDoc中,这意味着应该排除该成员的XML文档。来自documentation

  

<exclude/>代码指示NDoc从文档中排除当前项目。

我不清楚这是否最初是NDoc特定的,但它似乎也得到Sandcastle的支持(因为它在Sandcastle XML comments guide中)。

答案 1 :(得分:3)

来自Sandcastle Help File Builder documentation

  

命名空间通过Namespace Summaries属性或   项目被排除,因为其XML评论包含&lt; exclude /&gt;   标签。此信息将自动与API过滤器合并   设置。要更改这些项,您需要使用命名空间   汇总属性或从项目的XML注释中删除标记。

官方回复:

A way to exclude documentation?

有关此行为的更多信息:

Problems with missing members and tag