При использовании внешней сборки, которая поставляется с файлом документации XML, как мне получить визуальную студию, чтобы ее найти?Как использовать файлы документации XML
Имея файл документации XML, есть ли программа преобразования программы или xml или что-то, что я могу использовать, чтобы посмотреть на нее в хорошем смысле? Не обязательно в комплексе, как MSDN просмотра документации штуковина, но по крайней мере что-то лучше, чем чистый XML ...
1: вы просто поместите его в ту же папку, как DLL
2: это нужно сохраняться? Для «живого» использования, как VS IDE, так и «рефлектор» позволяют просматривать документацию (против типов/членов/и т. Д.). Есть инструменты для его преобразования, но я никогда не беспокоился. Sandcastle может стоить того, чтобы посмотреть, но это было не так приятно; -p
Ответ на первый вопрос: XML, должны иметь такое же имя, как сборка и быть рядом к нему. Поэтому, если у вас есть сборка под названием Svish.dll, то ваш файл документации должен быть Svish.xml и находиться в том же каталоге.
1) Файл документации должен иметь то же имя, что и имя сборки, с добавленным расширением «.xml» и находиться в том же как соответствующую сборку. Например, у вас есть файл MyCompany.MyNamespace.dll и файл MyCompany.MyNamespace.dll.xml в том же каталоге.
2) NDOC может генерировать некоторые форматы документации dirrent.
В примерах, которые я видел, и это сработало для меня, это было похоже на ответ Марка Гравелла. То есть: 'MyCompany.MyNamespace.xml' не' MyCompany.MyNamespace.dll.xml'. –
Относительно 2: Вы должны иметь возможность просмотреть «красивую версию» документации с помощью обозревателя объектов («Просмотр»> «Обозреватель объектов» (Ctrl W + J)), а затем просмотреть свой путь к классу, для которого нужно просмотреть документации. Я использовал Обозреватель объектов, чтобы просмотреть свою собственную документацию, поскольку она более дружелюбна читателю, чем файлы xml или комментарии.
Я попытался сбросить его в той же папке, но он не хочет его подбирать. У меня до сих пор нет документации. – Svish
Файлы должны быть Foo.Bar.dll и Foo.Bar.xml (например); вы уверены, что ссылаетесь на dll из этого места? И вы уверены, что это файл комментариев? –
Похоже, мне пришлось перезапустить VS, чтобы он работал ... есть ли команда пересоздать/перечитать документацию или что-то еще? – Svish