Как получить XML-документацию для библиотеки C #, на которую есть ссылки? - PullRequest
8 голосов
/ 17 ноября 2010

Предположим, у вас есть библиотека C # с несколькими функциями, все задокументированные с обычной /// <summary>, заполненной красиво. При ссылке на проект описание функции и параметров отображается в контекстной справке Visual Studio. Но возможно ли это показать, если вы не ссылаетесь на сам проект, а только на сборку (и, возможно, на какой-то другой файл, в котором есть документация)?

1 Ответ

14 голосов
/ 17 ноября 2010

Да, есть - библиотека должна быть собрана с установленным флажком «Файл XML-документации» (на страницах свойств проекта)

alt text

С этой опцией процесс сборки теперь будет создавать дополнительный XML-файл в выходном каталоге, который содержит всю документацию xml - всякий раз, когда Visual Studio ссылается на сборку по файлу, он загружает и показывает документацию intellisense из этого XML-файла (если это можно найти).

alt text

Вы должны распространять этот файл вместе (в том же каталоге, что и ваша откомпилированная библиотека).

...