Export (0) Print
Expand All

<param>

<param name='name'>description</param>

where:

name
The name of a method parameter. Enclose the name in single 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.

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

// xml_param_tag.cs
// compile with: /doc:xml_param_tag.xml 

/// text for class MyClass
public class MyClass 
{
   /// <param name="Int1">Used to indicate status.</param>
   public static void MyMethod(int Int1) 
   {
   }
   /// text for Main
   public static void Main () 
   {
   }
}

See Also

Recommended Tags for Documentation Comments

Show:
© 2014 Microsoft