Структура определения goto показывает комментарии, генерируются ли они из комментариев xml?

Question

Недавно я был слегка удивлен, обнаружив, что мои тщательно обработанные комментарии xml не появлялись в intellisense для моих коллег. Всегда используя связанные сборки с ссылками на проекты, я не понял, что вам нужно было экспортировать XML-документ и получить доступ к этой информации.

Это привело меня к размышлению о том, как работает инфраструктура .Net framework intellisense. Если я правильно понимаю, файлы .xml должны быть скрыты где-то в специальной папке?

Но мой главный вопрос касается определения «Goto» - если вы определились с определением на сборке .Net framework, вы получите информацию, полученную из метаданных, - но также и с большим количеством полезных комментариев - это магически генерируемые из комментариев Xml, или кто-то должен написать макрос +, чтобы преобразовать их только для сборки? По-другому: как я могу получить этот эффект для своих собраний?

Answer 1

Ваши проекты сконфигурированы для создания документации XML? Просто потому, что вы добавляете комментарии к исходному коду, компилятор не будет генерировать XML-файл, если только это не сказано.

На странице свойств проекта перейдите на вкладку «Сборка» и посмотрите раздел «Выход». Вы должны увидеть запись в блоке под названием «Файл документации XML». Если текстовое поле, следующее за этим флажком, пусто, вы не создаете файл документации XML.

После получения файла документации XML вы должны увидеть свои комментарии в подсказках IntelliSense. Если вы включаете ссылки на другие проекты в качестве ссылки на проект, это должно происходить автоматически. Если вы включаете ссылки на сборки, вам необходимо убедиться, что xml-файл находится в том же месте, что и ссылка на сборку. (Когда вы создаете, вы должны получить xml-файлы для всех сборок, которые есть в папке bin/debug или bin/release, соответственно.)

Для самих сборщиков .NET Framework установлены соответствующие файлы документации xml как часть Рамочной основы. Для .NET 2.0, 3.0 или 3.5 файлы документации расположены по адресу C:\Windows\Microsoft.NET\Framework\v2.0.50727\en (при условии установки по умолчанию для Framework). Эти файлы используются всплывающими подсказками IntelliSense и функциональностью «Перейти к определению» в Visual Studio, чтобы отобразить эту информацию. Существует не какая-либо специальная обработка, которая имеет место, или выполняется макрос, чтобы это произошло. Единственная информация, которая, скорее всего, использует Visual Studio, представляет собой комбинацию ключей реестра для определения правильного пути к файлам документации.

Хотя вы, вероятно, могли бы найти файлы документации xml для своих собственных сборок в той же папке, я бы рекомендовал не делать этого, так как вы затем загрязняете установку Framework файлами, не связанными с Framework.