2011-06-25 62 views
33

我已经在C#中创建了一个'类库',它有许多带有汇总(XML文档注释)的函数。汇总中没有显示汇总,如果它被添加为参考

例如

///<summary> 
///Adds the two numbres 
///</summary> 
public void Add() 
{ 
    //statements 
} 

如果我使用的功能在同一个名称空间,其示出了总结,但如果我在一些ohter工作区(溶液)加入其作为参考其没有显示摘要。

如何使它可见我的其他解决方案,如果添加它作为参考,和扫管笏可能是这样的原因?

+1

[Try this](http://stackoverflow.com/questions/1329338/xml-comments-not-showing-on-vb-net) –

回答

33

您需要为程序集(名为myassembly.xml的文件)生成XML文档,并将其与您的其他项目引用的.dll一起复制。有关说明,请参阅this page in MSDN

+2

.NET框架程序集是如何提供Intellisense的呢?还有其他第三方控件,如telerik和免费的Ajax控件工具包 – Deeptechtons

+0

我必须重新启动VS才能应用此更改。 – BornToCode

2

当您编译具有xml注释的类时,通常会创建一个.xml文件 。 (检查Visual Studio中的选项)

当您添加对此类程序集的引用时,请确保XML文件存在。 该文档不包含在程序集中,但包含在xml文件中。

30
  1. 转到您的源代码的解决方案资源管理器。右键点击项目名称并去属性
  2. 转到构建选项卡如果您使用c#并选中复选框xml文档文件
  3. 当您构建源代码时,将在您的dll所在的位置生成Xml文件。
  4. 虽然复制您的dll到解决方案复制xml文件并粘贴到您的目标解决方案的bin。
+1

就像提醒一样,Debug和Release有独立的设置!您可以在项目设置中单独选中/取消选中“Xml文档文件”。 –