沙堡帮助文件生成器（SHFB）。从源代码文件控制在帮助文件中添加/不添加类

Question

在Sandcastle帮助文件构建器（SHFB）中 是否可以从源代码文件控制帮助文件中的添加/不添加类？

例如，从帮助文件中删除没有注释的类。

我可以在帮助文件生成器中使用API​​过滤器。 但是，在“ API筛选器”对话框中的大型类树中跟踪数据非常无聊。 使用属性或特殊注释在源文件中直接标记\未标记类（方法，属性）会很方便。

Answer 1

AFAIK-exclude元素用于指示应从文档中排除特定类型或成员。

/// <summary>
/// This method will not appear in the help file even though it is public.
/// </summary>
/// <exclude />
public void UndocumentedMethod()
{
}

请注意-这是由Sandcastle帮助文件构建器实现的自定义XML注释元素。它不会出现在XML注释IntelliSense的有效元素列表中。

不建议使用此元素，而希望使用项目的API筛选器项目属性来排除成员。帮助文件构建器会将带有此元素的成员转换为API过滤器条目。请注意，如果在重载成员上使用，则由于API筛选器在Sandcastle中的工作方式，该重载成员的所有版本都将从文档中删除。

您应该使用API Filter Property明确包含/排除某些类和名称空间。