Могут ли классы реализации "наследовать" комментарии XML от их реализованных интерфейсов?
Любопытный вопрос. Я использую Microsoft Sandcastle для создания документации из комментариев XML в моем коде С#. Некоторые из моих классов реализуют интерфейсы, которые уже имеют методы комментариев. Я бы предпочел не дублировать документацию как по методу интерфейса, так и по общедоступному методу. Есть ли какой-то тег, который я могу использовать для "наследования" этой документации из интерфейса?
Ответы
Ответ 1
Эта функция не существует в настоящее время в Visual Studio.
Вы можете получить сторонние инструменты, такие как GhostDoc, которые помогут создать XML-документацию. GhostDoc также имеет возможность генерировать документацию, которая была "унаследована", как вы пытаетесь сделать.
Ссылка: GhostDoc
Ответ 2
Вы можете добавить <inheritdoc/>
в реализацию.
Вам следует взглянуть на следующий поток:
Способы синхронизации комментариев интерфейса и реализации на С#
Ответ 3
Если кто-то ищет решение, я построил библиотеку для последующей обработки файлов документации XML, чтобы добавить поддержку для < inheritdoc/ > тег.
Дополнительная информация на www.inheritdoc.io (доступна бесплатная версия).