Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining

<paramref> (C# Programming Guide)

<paramref 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()
© 2015 Microsoft