<remarks>(C# 编程指南)

<remarks>description</remarks>

参数

  • Description
    成员的说明。

备注

<remarks> 标记用于添加有关某个类型的信息,从而补充由 <summary> 所指定的信息。 此信息显示在 Object Browser Window 中。

使用 /doc 进行编译可以将文档注释处理到文件中。

示例

// compile with: /doc:DocFileName.xml 

/// <summary>
/// You may have some primary information about this class.
/// </summary>
/// <remarks>
/// You may have some additional information about this class.
/// </remarks>
public class TestClass
{
    /// text for Main
    static void Main()
    {
    }
}

请参见

参考

建议的文档注释标记(C# 编程指南)

概念

C# 编程指南