c# - 如何忽略帮助文件生成器为公共类或方法生成的文档？

Question

如何在 SandCastle Help File Builder 生成的文档中省略某些公共类或方法？

示例：我有以下带有两个公共方法的公共类：

/// <summary>
/// A simple test class.
/// </summary>
public class MyClass
{
    /// <summary>
    /// Method1s this instance.
    /// </summary>
    public void Method1()
    {
        // Do some operations here.
    }

    /// <summary>
    /// Method2s this instance.
    /// </summary>
    public void Method2()
    {
        // Do some operations here.
    }
}

当我使用 SandCastle Help File Builder 从此代码生成帮助文件时，我想忽略Method2.

Answer 1

（这是一个更新，因为自从 Thomas Levesque 发表评论后，用户界面似乎发生了变化。这也与我在网上其他地方找到的一些信息不同。）

在最新版本的 SandCastle 中，截至 2014 年 5 月 31 日，您必须经过 3 个步骤才能到达那里。

1. 在独立 UI 中，选择项目属性选项卡。
2. 左侧应该有一个类别列表。选择可见性
3. 单击编辑 API 过滤器按钮；这是在右侧的底部。

从那里，您将找到 API 条目列表。您可以单独取消选择类、命名空间和类中的项目（属性、字段、方法）。

Answer 2

在 Sandcastle Help File Builder GUI 的项目属性中，编辑ApiFilter属性（单击“...”按钮）并取消选中您不想在帮助文件中看到的成员。