paramref

The <paramref> tag indicates that a word is a parameter.

<paramref name="name"/>

where:

name

The name of the parameter to refer to. Enclose the name in double quotation marks (" ").

Applies To

Can be used inline within any other markup.

Remarks

Example

[C#]
/// text for class MyClass
public class MyClass
{
   /// <remarks>MyMethod is a method in the MyClass class.  
   /// The <paramref name="Int1"/> parameter takes a number.
   /// </remarks>
   public static void MyMethod(int Int1)
   {
   }

   /// text for Main
   public static void Main ()
   {
   }
}

See Also

Tag Usage | NDoc3 Tags | Microsoft's definition