沙堡帮助文件生成器(SHFB)。控件从源代码文件添加/不添加帮助文件中的类

Question

在沙堡帮助文件生成器(SHFB)中，是否可以从源代码文件中控制在帮助文件中添加/不添加类？

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

我可以使用帮助文件生成器中的API过滤器。但是在API过滤器对话框中跟踪大类树中的数据是非常乏味的。使用属性或特殊注释直接在源文件中标记\取消标记类(方法、属性)会很方便。

Answer 1

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

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

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

此元素已弃用，取而代之的是使用项目的API筛选器项目属性来排除成员。帮助文件生成器将具有此元素的成员转换为API筛选器条目。请注意，如果在重载成员上使用，由于API筛选器在Sandcastle中的工作方式，该重载成员的所有版本都将从文档中删除。

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