<paramref>(C# 编程指南)

<paramref name="name"/>

参数

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

备注

<paramref> 标记提供了指示代码注释中的某个单词(例如在 <summary> 或 <remarks> 块中)引用某个参数的方式。 可以处理 XML 文件来以不同的方式格式化此单词,比如将其设置为粗体或斜体。

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

示例

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.  
    /// The <paramref name="Int1"/> parameter takes a number.
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

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

请参见

参考

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

概念

C# 编程指南