通过

<param>（C# 编程指南）

  • 项目
<param name="name">description</param>

参数

  • name
    方法参数名。 将此名称用双引号括起来 (" ")。

  • description
    参数说明。

备注

<param> 标记应当用于方法声明的注释中，以描述方法的一个参数。 如要记录多个参数，请使用多个 <param> 标记。

有关 <param> 标记的文本将显示在 IntelliSense、对象浏览器和代码注释 Web 报表中。

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

示例

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    // Single parameter.
    /// <param name="Int1">Used to indicate status.</param>
    public static void DoWork(int Int1)
    {
    }

    // Multiple parameters.
    /// <param name="Int1">Used to indicate status.</param>
    /// <param name="Float1">Used to specify context.</param>
    public static void DoWork(int Int1, float Float1)
    {
    }

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

请参见

参考

建议的文档注释标记（C# 编程指南）

概念

C# 编程指南