Question

如何在SandCastle帮助文件生成器生成的文档中省略某些公共类或方法？

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

/// <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帮助文件生成器从此代码生成帮助文件时，我想忽略Method2。

Answer 1

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

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

在独立用户界面中，选择项目属性标签。
左侧应该有一个类别列表。选择可见性
点击修改API过滤器按钮;这是在右边的from的底部。

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

Answer 2

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

如何忽略公共类或方法的帮助文件构建器生成的文档？

2 个答案: