Наследовать документацию в C #?

Question

Из Java и Eclipse я привык к @inheritDoc, что позволяет использовать ту же документацию, что и в базовом классе / методе.

Как мне добиться чего-то подобного в C # и Visual Studio 2010?

Answer 1

Даже этому вопросу несколько лет, и он был специально для Visual Studio 2010. Для всех тех, кто попадает сюда от Google, я хотел бы добавить ответ, который я нашел и который справедлив для Visual Studio 2015 в сочетании с Построитель файлов справки Sandcastle (SHFB):

/// <inheritdoc/>

может использоваться для наследования документов от базового класса или интерфейса.

Вот ссылка на документацию по справочнику Sandcastle (SHFB): Использование тега

Answer 2

Не существует в Ванили VS. Ваш лучший выбор - ghostdoc или аналогичный. Это доступно в Extension Manager, или здесь

Answer 3

ReSharper не только предоставляет сочетания клавиш для копирования комментариев базового класса, но и фактически включает в себя <inheritdoc> комментарии в своем собственном интеллектуальном значении так, как вы хотите.Это работает, только если вся ваша команда использует ReSharper, конечно.Использование <inheritdoc> хорошо объяснено здесь

Answer 4

Я закончил тем, что создал инструмент для добавления поддержки замены тега <наследник_документа /> путем последующей обработки файлов документации XML. Доступно по адресу www.inheritdoc.io (доступна бесплатная версия).

Answer 5

My addin, AtomineerUtils будет дублировать документацию из переопределений базового класса и методов / свойств интерфейса, из-за перегрузок в том же классе, а также для параметров он будет искать параметры с такими же именами, используемые в других местах того же класса.

Вы также можете использовать XML-команды расширения, такие как или , если вы хотите дублировать текст во внешней документации (Sandcastle, Doxygen и т. Д.), Но я не знаю ни одного способа " динамически «наследующая документация для« внутреннего »использования (intellisense и т. д.)

Answer 6

Resharper предоставляет ярлыки для копирования документации XML из базовых классов.

Answer 7

NDoc3 .

NDoc3 основан на NDoc и является средством создания документации кода для разработчиков .NET.Цель состоит в том, чтобы создать быстрый, расширяемый, многоплатформенный инструмент для документирования .NET, который поддерживает все спецификации языков .NET, включая, но не только, C #