存储注释的位置以及如何提取注释?

时间:2014-03-19 14:04:50

标签: c# .net visual-studio reflection clr

假设我们有以下代码:

/// <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可以使用评论,我也想要。

1 个答案:

答案 0 :(得分:8)

  

C#编译器在汇编中存储注释?

它没有。

  

如果IntelliSence可以使用评论,我也想要。

在这种情况下,您需要在构建中启用XML文档生成。 (假设您正在使用Visual Studio,请转到项目属性,“构建”选项卡,“输出”部分,&#34; XML文档文件&#34;。

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

有关详细信息,请参阅MSDN guide to C# documentation comments。您可能还想查看Sandcastle Help File Builder以从评论中创建网页,CHM文件等。