c# - 评论存储在哪里以及如何提取它们？

Question

假设我们有如下代码:

/// <summary>
/// Test class comment
/// </summary>
public class Test
{
    /// <summary>
    /// Method comment
    /// </summary>
    /// <param name="a">First parameter comment</param>
    /// <param name="b">Second parameter comment</param>
    /// <returns>Return value comment</returns>
    public int Foo(int a, int b) { return 1; }
}

C# 编译器在汇编中的什么地方存储注释？如果 IntelliSence 可以使用注释，我也想要。

Answer 1

Where does the C# compiler store comments in assembly?

不是。

If IntelliSence can use comments, I also want.

在这种情况下，您需要在构建中启用 XML 文档生成。 (假设您使用的是 Visual Studio，转到您的项目属性、“构建”选项卡、“输出”部分、“XML 文档文件”。

这将吐出一个包含文档注释的单独文件(通常是程序集的名称，扩展名为 .xml)。不过，这将不包括所有注释 - 仅包括 XML 文档注释。

参见 MSDN guide to C# documentation comments更多细节。您可能还想看看 Sandcastle Help File Builder从评论中创建网页、CHM 文件等。