25

我有一个包含非常详尽的基于 XML 的文档的程序集,它通过 Sandcastle 用于生成产品的帮助文件。当程序员明显使用程序集时,我们还使用输出 XML 文件在 Visual Studio 中提供适当的 Intellisense。

为了做到这一点,我们似乎同时向用户提供了程序集(“assembly.dll”)和文档(“assembly.xml”)。

是否可以在程序集中嵌入文档,因此我们只需要提供单个程序集文件,Visual Studio 就可以提取信息?也许嵌入为资源或类似的东西?

4

3 回答 3

13

不幸的是,您需要同时提供两者,因为 Visual Studio 只知道查看 Intellisense 的 XML 文档。

于 2008-10-14T15:17:27.693 回答
6

如果您搜索 C:\Windows\Microsoft.NET\Framework\v2.0.50727,您会发现您可能在应用程序中引用的所有 .net 程序集都在使用 xml 文件。如果 xml 文件存在,Visual Studio 只会为程序集提供智能感知。例如,如果您要关闭 Visual Studio,然后删除 System.Drawing.xml 文件,然后重新打开 VS,则该程序集不应该有任何智能感知。然后,您需要关闭 VS,将其复制回来,然后重新打开 VS 以使智能感知再次工作。

于 2008-10-30T22:30:20.753 回答
1

我错过了什么吗?我总是像往常一样评论(使用 3 个斜杠或 3 个刻度线 (vb)),使用内置的 xml 标签,当我使用程序集时,我得到了智能感知 - 我很少使用外部 xml 文件。

于 2008-10-14T23:32:24.823 回答