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

Question

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

Answer 1

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

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

Связь: ПризракДок

Answer 2

Можете добавить <inheritdoc/> в реализации.

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

Answer 3

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

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