Как можно сохранить комментарии XML исходного кода .NET в метаданных сборки?

Question

Вы заметили, что для некоторых методов в системных сборках .NET Reflector также показывает соответствующую документацию? Это означает, что документация может быть сохранена в метаданных сборки.

Как я могу заставить это работать для моих собственных сборок? Это означает, что я хочу видеть свои комментарии к своему методу, когда отражаю его в .NET Reflector.

Спасибо.

Answer 1

Комментарии в формате XML не сохраняются в метаданных сборки. Фактически, Visual Studio и другие инструменты, такие как Reflector, находят комментарии к документам XML путем поиска по ряду известных путей, содержащих файлы комментариев к документам XML.

Если вы хотите просмотреть документацию XML для своих сборок, убедитесь, что файл XML находится в том же каталоге, что и ссылка на сборку, и имеет то же имя, что и ваша сборка (за исключением расширения). Например, MyAssembly.Namespace.XML соответствует сборке MyAssembly.Namespace.dll.

См. Как просмотреть XML-комментарии кода от Reflector для получения дополнительной информации.