在汇编中嵌入Intellisense Xml文档?

时间:2008-10-14 12:20:50

标签: xml visual-studio documentation assemblies intellisense

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

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

在某种程度上可以将文档嵌入到程序集中,所以我们只需提供单个程序集文件,Visual Studio就能提取信息吗?也许嵌入资源或类似的东西?

3 个答案:

答案 0 :(得分:13)

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

答案 1 :(得分:6)

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

答案 2 :(得分:1)

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