c# - 一种将 xml 注释从一组 API 复制到另一组类似 API 的方法？

Question

假设在 Visual Studio 中我有一个新项目，其中包含一些与旧项目相同的 API，我想将 xml 文档复制到新项目中。有没有一种方法可以做到这一点，而无需手动将它们一一复制粘贴？

Answer 1

我维护着一个开源项目，该项目实现了支持以编程方式访问 XML 文档注释的功能。参见 Jolt.NET有关该项目的更多信息，特别是“Querying XML Doc Comments”以获取此功能的文档。

这是一个示例，说明如何使用该库来实现您正在寻找的内容。

using Jolt;
using System.Xml.Linq;

void CopyXmlDocComments(Assembly sourceAssembly)
{
    XDocument newDocComments = new XDocument();
    XmlDocCommentReader reader = new XmlDocCommentReader(sourceAssembly);

    foreach(Type t in sourceAssembly.GetTypes())  // implement type filter here
    {
        newDocComments.Add(reader.GetComments(t));
    }

    newDocComments.Save("newAssemblyName.dll.xml");
}

在这个例子中，我假设你想在两个程序集中复制相似类型的文档注释。如果您需要将复制进一步限制到特定成员，您也可以使用库来完成，但您需要自己实现方法过滤逻辑。