Могу ли я распространять документацию XML от интерфейса до его реализации?

Question

Мне нужно распространять документацию XML из базового класса в производную (ые) или из интерфейса в реализацию (и).

Могу ли я сделать это с помощью Resharper?

Answer 1

Да, вы можете.

Если вам еще предстоит реализовать / переопределить элементы, то в реализации производного класса или интерфейса нажмите Alt + Ins , выберите «Переопределение элементов» или «Реализация отсутствующих элементов». ». В мастере, который отображается впоследствии, выберите элементы для реализации / переопределения и обязательно выберите «Копировать документацию XML».

В качестве альтернативы, если у вас уже есть переопределенный или реализованный элемент, нажмите Alt + Введите на переопределенном / внедренном элементе и выберите «Копировать комментарии из базы».

Answer 2

Начиная с 2016.2 EAP 9, ReSharper поддерживает тег <inheritdoc /> ( RSRP-33352 ).Вы увидите накопленную документацию с использованием QuickDoc (по умолчанию Ctrl + Shift + F1 ).

The Поколение элементов * Страница параметров 1015 * была расширена другим параметром для автоматического добавления этого тега в любой созданный элемент.У вас также будет контекстное действие для участников, у которых еще нет документации.

Я также могу порекомендовать XmlDoc Inspectionsплагин , который как-то связан с темой.