智能感知不显示为引用的DLL xmlDoc中， [英] Intellisense not showing XMLDOC for referenced DLL

问题描述

我使用的是VS-2010旗舰版10.0.30319.1 RTMRel（从约盒）。

I'm using VS-2010 Ultimate version 10.0.30319.1 RTMRel (from the about box).

我写了一个类库，有很多漂亮的xmlDoc中（恕我直言）的。至于原因，我不想进入，当我使用这个库中的各种解决方案的项目本身不包含（如右键单击解决方案，加上现有的项目。）;相反，我们只需添加一个引用到DLL，如果它是一个第三方库。

I have written a class library with lots of nice XMLDOC (imho). For reasons I don't want to get into when I use this library in various solutions the project itself is not included (as in right-click solution, add existing project..); instead, we just add a reference to the DLL as if it was a third-party library.

在包含库中的解决方案，智能感知工作正常，我也得到了xmlDoc中充分受益。不幸的是，这不是在那里我会用它！

In the solution that contains the library, intellisense works as normal and I get the full benefit of the XMLDOC. Unfortunately, that's not where I will be using it!

在其他的解决方案，其中库只是一个被引用的DLL，我得到智能感知，但没有xmlDoc中。虽然我的图书馆主要是足够的理解不支持，车轮使用我不知道这是为什么，以及是否有什么我可以做些什么。

In other solutions, where the library is just a referenced DLL, I get intellisense, but no XMLDOC. While my library is mostly understandable enough to use without the support wheels I wonder why this is and whether there's anything I can do about it.

非常跳过一段话：我希望，而愤世嫉俗的怀疑跨越，因为我觉得这是我的头脑是毫无根据的 - 那就是M $可能锁定此功能在某些方面，以销售进入到第三三方库开发......我想一个可以的做这样的事情需要DLL由特定密钥签名，并提供了一​​些在线支付服务，人们可以用此键签上自己的DLL来启用的功能，但由于它的平台如何有价值，有库和组件的蓬勃发展的第三方开发者似乎不太可能任何人都应该打扰。

Very skippable paragraph: I hope the rather cynical suspicion that crossed my mind is as baseless as I think it is - namely, that M$ might have "locked" this functionality in some way in order to sell access to it to third-party library developers... I suppose one could do something like require the DLL to be signed by a particular key and offer some online for-pay service where people could sign their DLLs with this key to enable the functionality, but given how valuable it is to the platform to have thriving third-party developers of libraries and components it seems unlikely anyone should bother.

所以，没有任何人有任何提示，以分享如何得到这个工作？我想了xmlDoc中，以显示在智能感知，每当我用，不管是怎么回事。 ：）

So, does anyone have any tips to share on how to get this working? I'd like the XMLDOC to show up in intellisense whenever I use the thing, regardless of how. :)

推荐答案

不包含实际的注释文档的组件。你需要生成一个包含所有文档的XML文件。

The assembly does not contain the actual comment documentation. You need to generate an XML file that contains all your documentation.

进入您的项目设置，在构建选项卡中勾选XML文档文件：

Go into your projects Settings, on the Build tab Check "XML Documentation File":

现在，当您编译您的项目，一个不错的XML文件将被制作包含的文档。

Now when you compile your project, a nice XML file will be produced containing the documentation.

在你的其他项目中，你需要引用的DLL，并确保该XML具有相同的名称与XML扩展，而不是DLL的程序集，并且是在相同的目录中引用的DLL。例如：

In your other project, you need to reference the DLL and make sure that the XML has the same name as your assembly with an XML extension instead of DLL, and is in the same directory as your referenced DLL. For example:

大会：MyProject.dll

Assembly: MyProject.dll

XML：MyProject.xml

XML: MyProject.xml

您可以了解更多关于XML文档在MSDN

You can learn more about XML documentation at MSDN.

这篇关于智能感知不显示为引用的DLL xmlDoc中，的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！