NDoc User's Guide

NDoc 1.3

<param>

[This is preliminary documentation and subject to change]

The <param> tag describes one of the parameters for the method.

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

Applies To

Property, Method, Event, Operator.

Remarks

Example

[C#]
/// 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

Tag Usage | NDoc Tags | Microsoft's definition