Как игнорировать документацию, сгенерированную конструктором файла справки для общедоступного класса или методов?

Question

Как я могу опустить некоторые общедоступные классы или методы из того, что они включены в документацию, созданную The 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

В свойствах вашего проекта в Sandcastle Help File Builder GUI отредактируйте свойство ApiFilter (нажмите кнопку «...») и снимите флажки с элементов, которые вы не хотите видеть в файле справки.

Answer 2

(Это обновление, так как пользовательский интерфейс, кажется, изменились с тех пор Thomas Levesque разместил свой комментарий. Также отличаются некоторой информацией я нашел другие места в Интернете.)

В последней версии SandCastle , по состоянию на 31 мая 2014 года вам нужно пройти 3 шага, чтобы добраться туда.

1. В автономном интерфейсе выберите Свойства проекта вкладку.
2. Должен быть список категорий слева. Выберите Видимость
3. Нажмите Редактировать фильтр API button; это находится внизу от справа.

Оттуда вы найдете список записей API. Вы можете индивидуально отменить выбор классов, пространств имен и элементов внутри класса (свойства, поля, методы).