<param>(C# 编程指南)

更新:2007 年 11 月

<param name='name'>description</param>

参数

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

  • description
    参数说明。

备注

<param> 标记应当用于方法声明的注释中,以描述方法的一个参数。

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

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

示例

// compile with: /doc:DocFileName.xml 

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

请参见

概念

C# 编程指南

参考

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