注释标记

概述

<permission>

<typeparamref>

<typeparam>

<remarks>

<value>

<seealso>

<see>

<returns>

<summary>

<c>

<paramref>

<param>

<para>

<list>

<include>

<exception>

<example>

<code>

<c>

语法

<c>text</c>

参数

  • text

    要指示为代码的文本。

备注

使用 <c> 标记可以指示应将说明内的文本标记为代码。 使用 <code> 指示作为代码的多行文本。

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

示例

// compile with: -doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary><c>DoWork</c> is a method in the <c>TestClass</c> class.
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}