<param> (C# Programming Guide)

 

Updated: July 20, 2015

For the latest documentation on Visual Studio 2017 RC, see Visual Studio 2017 RC Documentation.

<param name="name">description</param>  

Parameters

name
The name of a method parameter. Enclose the name in double quotation marks (" ").

description
A description for the parameter.

The <param> tag should be used in the comment for a method declaration to describe one of the parameters for the method. To document multiple parameters, use multiple <param> tags.

The text for the <param> tag will be displayed in IntelliSense, the Object Browser, and in the Code Comment Web Report.

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

    // 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# Programming Guide
Recommended Tags for Documentation Comments

Show: