Построитель файлов справки Sandcastle (SHFB).Управление Добавить / Не добавлять классы в файле справки из файла исходного кода

Question

В конструкторе файлов справки Sandcastle (SHFB) Можно ли управлять добавлением / не добавлением классов в файле справки из файла исходного кода?

Например, удалить классы из файла справки для классов, которые неесть комментарии.

Я могу использовать API Filter в File File Builder.Но отслеживание данных в большом дереве классов в диалоге API Filter смертельно скучно.Было бы удобно пометить \ снять отметки с классов (методов, свойств) непосредственно в исходных файлах с помощью атрибутов или специальных комментариев.

Answer 1

AFAIK - элемент exclude используется для указания того, что определенный тип или элемент должен быть исключен из документации.

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

Обратите внимание - это пользовательский XMLЭлемент комментариев, реализованный в конструкторе файлов справки Sandcastle.Он не будет отображаться в списке допустимых элементов для комментариев XML IntelliSense.

Этот элемент устарел в пользу использования свойства проекта фильтра API проекта для исключения членов.Конструктор файлов справки преобразует элементы с этим элементом в запись фильтра API.Имейте в виду, что при использовании перегруженного элемента все версии перегруженного элемента будут удалены из документации в связи с тем, как работает фильтр API в Sandcastle.

Вам следует использовать Свойство API-фильтра для явного включения / исключения определенных классов и пространств имен.