<paramref> (C# programming guide)


<paramref name="name"/>


  • name

    The name of the parameter to refer to. Enclose the name in double quotation marks (" ").


The <paramref> tag gives you a way to indicate that a word in the code comments, for example in a <summary> or <remarks> block refers to a parameter. The XML file can be processed to format this word in some distinct way, such as with a bold or italic font.

Compile with -doc to process documentation comments to a file.


// 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()

See also