Как использовать файлы документации XML

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

Ответ 1

1: вы просто бросаете его в ту же папку, что и dll

2: нужно ли его сохранять? Для "живого" использования, как VS IDE, так и "рефлектор" позволяют просматривать документацию (против типов/членов/и т.д.). Есть инструменты для его преобразования, но я никогда не беспокоился. Sandcastle может стоить взгляда, но мне это никогда не было приятно;-p

Ответ 2

Что касается 2: вы должны иметь возможность взглянуть на "симпатичную версию" документации с помощью обозревателя объектов ( "Просмотр" > "Обозреватель объектов" (Ctrl W + J)), а затем просмотреть свой путь к классу, для которого можно просмотреть документация. Я использовал Обозреватель объектов, чтобы просмотреть свою собственную документацию, поскольку она более дружелюбна читателю, чем файлы xml или комментарии.

Ответ 3

Отвечайте на свой первый вопрос: xml должен иметь то же имя, что и сборка, и быть рядом с ним. Поэтому, если у вас есть сборка под названием Svish.dll, то ваш файл документации должен быть Svish.xml и находиться в том же каталоге.

Ответ 4

1) Файл документации должен иметь то же имя, что и имя сборки, с добавленным расширением ".xml" и находиться в том же каталоге, что и соответствующая сборка. Например, у вас есть файл MyCompany.MyNamespace.dll и файл MyCompany.MyNamespace.dll.xml в том же каталоге.

2) NDOC может генерировать некоторые форматы документации dirrent.