Как удалить внутренние интерфейсы со страницы справки класса, созданной с помощью Sandcastle или SHFB? - PullRequest
1 голос
/ 27 декабря 2011

У меня есть класс, который реализует много внутренних интерфейсов, и я хотел бы, чтобы читатель документации не мог видеть, что класс реализует все эти внутренние интерфейсы, потому что эта информация не важна для читателей.

Например, если у меня есть следующий класс:

public class MyPublicClass : MyBasePublicClass, MyPublicInterface, MyInternalInterface1, MyInternalInterface2, MyInternalInterface3
{

}

public class MyBasePublicClass
{

}

public interface MyPublicInterface
{
    // Interface members...
}

internal interface MyInternalInterface1
{
    // Interface members...
}

internal interface MyInternalInterface2
{
    // Interface members...
}

internal interface MyInternalInterface3
{
    // Interface members...
}

Я хочу, чтобы программа чтения документации видела MyPublicClass следующим образом:

public class MyPublicClass : MyBasePublicClass, MyPublicInterface
{

}

Этого можно добиться с помощью Sandcastle или SHFB и как?

Спасибо!

Ответы [ 2 ]

1 голос
/ 27 декабря 2011

Я работаю с версией 1.9.3.0 графического интерфейса построителя файла справки Sandcastle, для которой в разделе «Видимость» задан параметр DocumentInternals Этот параметр удаляет только ссылки на внутренние интерфейсы и удаляет их из документации, но они всегда отображаются в классе.

Так что я думаю, что это не легко исправить. Редактирование файлов Sandcastle может быть решением.

0 голосов
/ 28 декабря 2011

Я также задавал этот вопрос на Sandcastle Codeplex Discussion - Как удалить внутренние интерфейсы со страницы справки класса?

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

Затем он открывает информационный файл отражения и удаляет информацию о реализации внутренних интерфейсов из типов, которые реализуют внутренние интерфейсы, и сохраняет измененный информационный файл отражения.

...