Встраивание документации Intellisense Xml в сборку?
-
03-07-2019 - |
Вопрос
У меня есть сборка, содержащая очень подробную документацию на основе XML, которая используется через Sandcastle для создания файлов справки для продукта.Мы также используем выходные XML-файлы для обеспечения надлежащего Intellisense в Visual Studio, когда программисты явно используют сборку.
Кажется, что для этого нам нужно предоставить пользователю как сборку («assembly.dll»), так и документацию («assembly.xml»).
Можно ли каким-то образом встроить документацию в сборку, чтобы нам нужно было предоставить только один файл сборки, и Visual Studio смогла бы извлечь информацию?Может быть, встроен как ресурс или что-то в этом роде?
Решение
К сожалению, вам придется предоставить оба варианта, поскольку Visual Studio умеет просматривать XML-документы только для Intellisense.
Другие советы
Если вы выполните поиск по C:\Windows\Microsoft.NET\Framework\v2.0.50727, вы обнаружите, что все сборки .net, на которые вы можете ссылаться в своих приложениях, используют файлы xml.Visual Studio будет предоставлять IntelliSense для сборок только в том случае, если XML-файл существует.Например, если вы закрыли Visual Studio, затем удалили файл System.Drawing.xml и снова открыли VS, для этой сборки не должно быть никакого IntelliSense.Затем вам нужно будет закрыть VS, скопировать его обратно, а затем снова открыть VS, чтобы intellisense снова заработал.
Я что-то пропустил?Я всегда комментирую как обычно (используя 3 косые черты или 3 деления (vb)), использую встроенные теги XML, и когда я использую сборку, я получаю intellisense - я редко использую внешний XML-файл.