是否可以在运行时获取类摘要？

Question

C# 是否可以在运行时获取类摘要？ 我想通过反射获取类摘要，然后将其写入控制台。 我所说的类摘要是指类定义之前的摘要注释，如下所示：

/// <summary>
/// some description
/// </summary>
class SomeClass
{
}

我不知道这些注释在编译代码后是否可用，但如果可用，也许有一种方法可以在代码中获取它们。

预先感谢您的帮助。

Answer 1

不久前我曾经搞乱过这个问题，并使用了这个人的解决方案。 效果很好：

http://jimblackler.net/blog/?p=49

Answer 2

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

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

Answer 3

不，它们无法通过反射获得。 请参阅 msdn：

XML 文档注释不是元数据；而是元数据。
它们不包含在编译中
组装，因此它们不是
通过反射访问。

Answer 4

您无法在运行时访问它们，因为编译器将它们视为注释。

但是，如果您想使用属性来指定信息并在运行时通过反射访问它，您可以这样做。

有关属性创建和 创建自定义属性（C# 编程指南），请参阅a href="http://msdn.microsoft.com/en-us/library/z919e8tw.aspx" rel="nofollow noreferrer">通过反射访问属性（C# 编程指南） 用于运行时访问。

来自 MSDN 的示例：

Author.cs：

public class Author : System.Attribute
{
    private string name;
    public double version;

    public Author(string name)
    {
        this.name = name;
        version = 1.0;
    }
}

SampleClass.cs：

[Author("H. Ackerman", version = 1.1)]
class SampleClass
{
    // H. Ackerman's code goes here...
}

Answer 5

如果您发出 XML 文档文件，则可以。 该过程将涉及使用反射来获取该类型的所有公共成员，然后使用 XPath 从生成的 XML 文档中读取文档。

更新：要将 XML 文档包含在 dll/exe 中，只需将其添加为嵌入式资源，并在文档发生更改时编译两次。

Answer 6

不，这些注释不包含在您编译的程序集中。

Visual Studio 可以在输出文件夹 (\bin\your_project.xml) 中创建一个包含这些注释的 .xml 文件。 如果您的应用程序随该 xml 文件一起分发，那么您将能够以编程方式访问它。