Intellisense没有显示引用DLL的XMLDOC

时间:2012-12-06 19:10:41

标签: .net visual-studio-2010 intellisense xml-documentation

我正在使用VS-2010 Ultimate版本10.0.30319.1 RTMRel(来自关于框)。

我编写了一个包含许多优秀XMLDOC(imho)的类库。由于我在各种解决方案中使用此库时不想进入的原因,项目本身不包括在内(如在右键单击解决方案中,添加现有项目..);相反,我们只是添加对DLL的引用,就像它是第三方库一样。

在包含库的解决方案中,intellisense正常工作,我获得了XMLDOC的全部好处。不幸的是,那不是我将要使用它的地方!

在其他解决方案中,库只是一个引用的DLL,我得到intellisense,但没有XMLDOC。虽然我的图书馆基本上可以理解,但没有支撑轮,我想知道为什么会这样,以及我能做些什么呢。

非常可跳过的段落:我希望我脑子里那种相当愤世嫉俗的怀疑是我认为的那样毫无根据 - 也就是说,M $可能以某种方式“锁定”了这个功能,以便将它的访问权卖给第三-party库开发人员...我想一个可以做一些事情,比如要求DLL由特定密钥签名,并提供一些在线付费服务,人们可以使用此密钥签署他们的DLL以启用功能,但鉴于拥有繁荣的第三方图书馆和组件开发人员对平台的价值有多大,似乎任何人都不应该费心去做。

那么,有没有人有任何提示可以分享如何使这个工作?无论如何,每当我使用这个东西时,我都希望XMLDOC出现在intellisense中。 :)

1 个答案:

答案 0 :(得分:14)

程序集不包含实际的注释文档。您需要生成包含所有文档的XML文件。

进入项目设置,在Build选项卡上检查“XML Documentation File”:

enter image description here

现在编译项目时,将生成一个包含文档的精美XML文件。

在您的其他项目中,您需要引用DLL并确保XML与具有XML扩展名而不是DLL的程序集具有相同的名称,并且与引用的DLL位于同一目录中。例如:

  

程序集:MyProject.dll

     

XML:MyProject.xml

您可以详细了解XML文档at MSDN