This page is specific to:.NET Framework Version:1.12.03.03.54.0
C# Programmer's Reference
<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

© 2009 Microsoft Corporation. All rights reserved.   Terms of Use | Trademarks | Privacy Statement
Page view tracker
Rate the Lightweight library
x
Lightweight builds on ScriptFree (loband) by adding features you've requested: a SearchBox and default code language selection.
Do you like the SearchBox?
Do you like the tabbed code blocks?
How useful is this topic?
Tell us more.
Thanks
x
You're helping to improve MSDN Online.
Feedback
Switch View
Classic
Lightweight Beta
ScriptFree
Switch View