Из Java и Eclipse я использую @inheritDoc
, который позволяет использовать ту же документацию, что и в базовом классе/методе.
Как я могу выполнить что-то подобное в С# и Visual Studio 2010?
Из Java и Eclipse я использую @inheritDoc
, который позволяет использовать ту же документацию, что и в базовом классе/методе.
Как я могу выполнить что-то подобное в С# и Visual Studio 2010?
Это не существует в ванильном VS. Ваш лучший выбор - ghostdoc или аналогичный. Это доступно в диспетчере расширений или здесь
Даже этот вопрос несколько лет, и это было специально для Visual Studio 2010. Для всех тех, кто приземляется здесь Google, я хотел бы добавить ответ, который я нашел, и это справедливо для Visual Studio 2015 в сочетании с Sandbule Help File Builder (SHFB):
/// <inheritdoc/>
может использоваться для наследования документов из базового класса или интерфейса.
Здесь приведена ссылка на документацию по файловому архиву Sandcastle (SHFB): Используя < inheritdoc/ > Метка
ReSharper не только предоставляет сочетания клавиш для копирования комментариев в базовом классе, но фактически включает в себя <inheritdoc>
комментарии в пользовательском intellisense так, как вы хотите. Это работает, только если вся ваша команда использует ReSharper.
Использование <inheritdoc>
объясняется хорошо здесь
Resharper предоставляет ярлыки для копирования документации XML из базовых классов.
My addin, AtomineerUtils будет дублировать документацию из переопределений базового класса и методов/свойств интерфейса, от перегрузок в том же классе и для параметров он также будет искать одинаковые параметры, используемые в другом месте того же класса.
Вы также можете использовать команды расширения XML, такие как <inheritdoc> или <include> если вы хотите дублировать текст во внешней документации (Sandcastle, Doxygen и т.д.), но я не знаю ни одного способа "динамически" наследующей документации для "внутреннего" использования (intellisense и т.д.)
В итоге я создал инструмент для добавления поддержки для замены < inheritdoc/ > тегом, после обработки файлов документации XML. Доступно в www.inheritdoc.io (доступна бесплатная версия).