.net - .net 中是否有用于读取 XML 注释文档文件的 API

Question

在这个问题中，我看到微软为 BCL 提供了 XML 文档文件。我想知道是否有人知道 .net 中是否有一个 API 可用于在运行时查找它。我知道我们可以使用 XML api 手动解析文件。

用例是我们允许在我们的系统中使用自定义（读取第 3 方）类型/程序集，并且在 UI 中选择这些时，我们希望提取自定义类型/程序集创建者指定的文档，或者如果不可用提供其他默认值。

score 7 · Accepted Answer

我在 CodePlex 上维护Jolt.NET项目，并实现了执行此任务的功能。有关更多信息，请参阅Jolt库。

本质上，该库允许您以编程方式定位和查询 XML 文档注释文件，以使用元数据类型System.Reflection（即MethodInfo，PropertyInfo等）中的程序集。

score 4 · Accepted Answer

Microsoft 的 Sandcastle是一种工具，用于在有或没有 XML 注释文件的帮助下从程序集中提取文档。它已作为开源发布。您可以尝试查看该工具的代码。

score 2 · Accepted Answer

让我们考虑一下。

XML 注释绝不是组装单元的一部分。因此，您正在谈论的第 3 方大会将没有任何信息可供您从中提取评论。

现在，如果这些程序集可以生成包含此文档的 XML 文件，可能使用 SandCastle 或 nDoc，那么您可以按照您的意愿读取这些 XML 文件。

接下来的问题是 - 假设您有这些 XML 文档文件，如何解析和阅读它们

我建议使用Linq to XML来快速轻松地加载此文档。这在很多方面都比 SandCastle 所做的 XSLT 处理要好。只要您了解 XML 文档文件的 XML 架构/层次结构，使用 Linq to XML 执行此操作不会花费那么长时间

让我知道情况如何，或者如果您有任何问题

score 2 · Accepted Answer

它使用访问者模式来遍历 XML 文档。

这是在GitHub

score 1 · Accepted Answer

1

您可能想要调查以下库

于 2009-05-02T16:10:28.943 回答

5 回答 5