Встраивание документации Intellisense Xml в сборку?

Question

У меня есть сборка, содержащая очень подробную документацию на основе XML, которая используется в Sandcastle для генерации файлов справки для продукта. Мы также используем выходные XML-файлы для обеспечения надлежащего Intellisense в Visual Studio, когда программисты, очевидно, используют сборку.

Для того, чтобы сделать это, кажется, мы должны предоставить пользователю как сборку ("assembly.dll"), так и документацию ("assembly.xml").

Можно ли каким-то образом встроить документацию в сборку, поэтому нам нужно будет предоставить только один файл сборки, а Visual Studio сможет извлечь информацию? Может быть встроен как ресурс или что-то в этом роде?

Answer 1

К сожалению, вам нужно будет предоставить и то, и другое, поскольку Visual Studio знает только, что нужно искать документы XML для Intellisense.

Answer 2

Если вы выполните поиск в C: \ Windows \ Microsoft.NET \ Framework \ v2.0.50727, вы обнаружите, что все сборки .net, на которые вы можете ссылаться в своих приложениях, используют файлы xml. Visual Studio будет предоставлять intellisense для сборок, только если существует файл XML. Например, если вы хотите закрыть Visual Studio, затем удалить файл System.Drawing.xml, а затем снова открыть VS, для этой сборки не должно быть никакого intellisense. Затем вам нужно будет закрыть VS, скопировать его обратно, а затем снова открыть VS, чтобы снова заработал intellisense.

Answer 3

Я что-то упустил? Я всегда комментирую как обычно (используя 3 слеша или 3 галочки (vb)), использую встроенные теги xml, и когда я использую сборку, я получаю intellisense - я редко использую внешний xml-файл.