“///<排除/>”是什么意思

本文关键字:是什么 意思 排除 | 更新日期: 2023-09-27 18:37:10

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

“///<排除/>”是什么意思

至少在 NDoc 中,这意味着应排除此成员的 XML 文档。从文档中:

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

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

来自 Sandcastle 帮助文件生成器文档:

命名空间通过命名空间摘要属性或 项目被排除,因为其 XML 注释包含<排除 /> 标记。此信息会自动与 API 筛选器合并 设置。要更改这些项目,您需要使用 命名空间 摘要属性或从项的 XML 注释中删除标记。

官方回复:

一种排除文档的方法?

以及有关该行为的更多信息:

缺少成员和标记的问题