This topic has not yet been rated - Rate this topic

<param> (C# Programming Guide)

Visual Studio 2012

<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.

Remarks

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.

Example

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

Reference

Recommended Tags for Documentation Comments (C# Programming Guide)

Concepts

C# Programming Guide

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)