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

Question

1. При использовании внешней сборки, которая поставляется с файлом документации XML, как мне заставить Visual Studio его найти?

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

Answer 1

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

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

Answer 2

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

Answer 3

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

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

Answer 4

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