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

Question

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

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

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

Answer 1

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

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

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

Для самих сборок .NET Framework соответствующие файлы документации xml устанавливаются как часть Framework. Для .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.