如果将摘要添加为参考，则摘要不会显示在程序集中

Question

我在 C# 中创建了一个“类库”，它有许多带有摘要的函数（XML 文档 cmets）。

例如

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

如果我在同一个命名空间中使用该函数，它会显示摘要，但如果我将它作为参考添加到某个其他工作区（解决方案）中，则它不会显示摘要。

如果将其添加为参考，如何使其在其他解决方案中可见，这可能是原因吗？

Answer 1

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

Answer 2

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

Answer 3

当你编译有 xml 注释的类时， 通常会创建一个 .xml 文件。 （检查 Visual Studio 中的选项）

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