如果将其添加为参考,则汇总不会显示在汇编中

时间:2011-06-25 09:15:48

标签: c# .net visual-studio xml-documentation

我在C#中创建了一个“类库”,它有许多带摘要的函数(XML文档注释)。

例如

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

如果我在相同的命名空间中使用该函数,它会显示摘要,但如果我在某些工作空间(解决方案)中将其添加为参考,则它不显示摘要。

如果将其添加为参考,如何使其可见其他解决方案,并且wat可能是这个的原因?

3 个答案:

答案 0 :(得分:43)

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

答案 1 :(得分:40)

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

答案 2 :(得分:2)

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

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