嵌入Intellisense Xml文档在装配？ [英] Embedding Intellisense Xml Documentation in Assembly?

问题描述

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

为了做到这一点，似乎我们都提供用户使用程序集（assembly.dll）和文档（assembly.xml）。

将文档嵌入到程序集中是有可能的，所以我们只需要提供单个程序集文件，Visual Studio就可以提取信息？可能嵌入资源或类似的东西？

解决方案

不幸的是，您将需要提供Visual Studio只知道看Intellisense的XML文档。

I have an assembly containing very thorough XML-based documentation, which is used through Sandcastle to generate the help-files for the product. We also use the output XML files for providing proper Intellisense in Visual Studio when programmers use the assembly obviously.

In order to do this, it seems we have do both supply the user with the assembly ("assembly.dll") and the documentation ("assembly.xml").

Is it somehow possible to embed the documentation within the assembly, so we'd only have to supply the single assembly-file and Visual Studio would be able to extract the information? Maybe embedded as a resource or something like that?

解决方案

Unfortunately you will need to supply both as Visual Studio only knows to look at XML documents for Intellisense.

这篇关于嵌入Intellisense Xml文档在装配？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！