Visual Studio Intellisense для cref в документации Xml

Question

Когда вы создаете документацию XML для методов C # в Visual Studio (я использую 2010), вы получаете поддержку Intellisense для создания различных тегов XML, таких как see, paramref и т. Д. С другой стороны, когда вы добавляете Атрибут cref Вы должны использовать, как мне кажется, сложный формат для описания типов. Это хуже всего, когда у вас есть несколько генериков.

Я ищу следующее. Если вы устанавливаете атрибут cref в элементе see, у вас есть список классов Intellisense, которые соответствуют тому, что вы уже набрали, и затем выводите правильное описание необходимого типа. Или, когда вы устанавливаете атрибут cref для элемента paramref, вы получаете список параметров этого метода.

Кто-нибудь знает какое-нибудь дополнение к Visual Studio, которое предоставляет Intellisense для этих атрибутов cref?

Answer 1

В последнее время я пишу много XML-документации, и я думаю, что ReSharper предоставляет нужную вам функциональность благодаря расширенной IntelliSense Code Completion - я использую еевсе время.Функцию Quick Documentation также не следует упускать из виду при написании документации - с ее помощью вы можете увидеть, как будет выглядеть документация XML при компиляции в html / chm, и она обновлена в режиме реального времени , поэтому, если я что-то изменяю в документах с окном быстрой документации, я вижу, что оно меняется автоматически - очень полезно для форматирования и тому подобного.

Если вы добавите Агент Смит к миксу (который, по-видимому, работает только как дополнение к ReSharper), он может добавить несколько удобных Проверка орфографии , Проверка XML-комментариев , проверки соглашения об именах и несколько простых перефразировок комментариев (если вы особенно стараетесь оставаться в пределах определенного количества символов / строки) (первые два, вероятно, наиболее полезны, поскольку ReSharper предоставляет возможность применять соглашения об именах).

Надеюсь, это поможет!