注释标记

概述

<permission>

<typeparamref>

<typeparam>

<remarks>

<value>

<seealso>

<see>

<returns>

<summary>

<c>

<paramref>

<param>

<para>

<list>

<include>

<exception>

<example>

<code>

<remarks>

语法

<remarks>description</remarks>

参数

  • Description

    对成员的说明。

备注

<remarks> 标记用于添加有关某个类型的信息，从而补充由 <summary> 指定的信息。 此信息显示在对象浏览器窗口中。

使用 -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()
    {
    }
}