Могут ли классы реализации «наследовать» комментарии XML от их реализованных интерфейсов?

Question

Любопытный вопрос. Я использую Microsoft Sandcastle для создания документации из комментариев XML в моем коде C #. Некоторые из моих классов реализуют интерфейсы, которые уже имеют закомментированные методы. Я бы предпочел не дублировать документацию как в методе интерфейса, так и в общедоступном методе. Есть ли какой-нибудь тег, который я могу использовать, чтобы «наследовать» эту документацию от интерфейса?

Answer 1

Вы можете добавить <inheritdoc/> в реализацию.

Вы должны взглянуть на следующую ветку: Способы синхронизации комментариев интерфейса и реализации в C #

Answer 2

Эта функция в настоящее время не существует в Visual Studio.

Вы можете получить сторонние инструменты, такие как GhostDoc, которые помогут в создании XML-документации. GhostDoc также имеет возможность генерировать документацию, которая была «унаследована», как вы пытаетесь это сделать.

Ссылка: GhostDoc

Answer 3

Если кто-то еще ищет решение, я собрал библиотеку для пост-обработки файлов документации XML, чтобы добавить поддержку тега .

Больше информации на www.inheritdoc.io (доступна бесплатная версия).