是否有.NET API来读取XML注释文档文件

问题描述：

在这种question我看到微软发布了BCL的XML文档文件。我想知道是否有人知道.net中的API是否可以用来在运行时查看。我知道我们可以使用XML API手动解析文件。是否有.NET API来读取XML注释文档文件

使用的情况是，我们允许自定义（读第三方）类型/组件在我们的系统中使用，并在UI选择这些的时候，我们想抽取文档由自定义类型指定/程序集创建者或者不可用时提供其他默认值。

我建议你看一看[NDoc的（http://ndoc.sourceforge.net/） – Vikram 2009-04-28 09:35:51

谢谢你，我已经做了。它不会做我以后的事情。 – 2009-04-29 08:21:03

你使用了什么或者你是如何做到的？ – Vikram 2009-04-29 08:38:25

答

我保持在CodePlex上的Jolt.NET项目，并实施执行这个非常任务功能。有关更多信息，请参阅Jolt库。

在本质上，图书馆可以让你以编程方式定位和System.Reflection使用元数据类型查询XML文档注释文件组件（即MethodInfo，PropertyInfo，等...）。

答

Microsoft's Sandcastle是有或没有XML注释文件的帮助从组件中提取文档的工具。它已经作为开源发布。您可以尝试查看该工具的代码。

嗯..我对Sandcastle的体会是它使用了XSL处理和反射。我会再检查一次。 – 2009-04-22 04:28:24

答

让我们想想这一点。

XML注释是从来没有装配单元的一部分。所以你正在讨论的第三方程序集将不会提供任何信息供你从中提取评论。

现在，如果这些组件可以生成包含这个文件，可能使用沙塔或NDoc的，那么你就可以读取这些XML文件作为你想要做的XML文件。

接下来的问题是 - 假设你有这些XML文档文件，如何对其进行解析并阅读他们

我会建议使用Linq to XML快速简便的方法来加载此文档。这比SandCastle所做的XSLT处理在许多方面都更好。使用LINQ to XML来做到这一点不应该那么长，只要你理解了XML文档文件的XML架构/层次采取

让我知道如何继续下去或者如果您有任何疑问

答

您可能需要调查以下库

答

它采用访问者模式走的XML文档。