paramref-visual-cpp.md

title	ms.custom	ms.date	ms.reviewer	ms.suite	ms.technology	ms.tgt_pltfrm	ms.topic	f1_keywords	dev_langs	helpviewer_keywords	ms.assetid	caps.latest.revision	author	ms.author	manager
&lt;paramref&gt; (Visual C++) | Microsoft Docs		11/04/2016			cpp-ide		article	paramref <paramref>	C++	paramref C++ XML tag <paramref> C++ XML tag	c5730dc2-7159-421f-b2d5-bb971e307122	9	mikeblome	mblome	ghogen

<paramref> (Visual C++)

The <paramref> tag gives you a way to indicate that a word is a parameter. The .xml file can be processed to format this parameter in some distinct way.

Syntax

<paramref name="name"/>  

Parameters

name
The name of the parameter to refer to. Enclose the name in single or double quotation marks. The compiler issues a warning if it does not find name.

Remarks

Compile with /doc to process documentation comments to a file.

Example

// xml_paramref_tag.cpp  
// compile with: /clr /doc /LD  
// post-build command: xdcmake xml_paramref_tag.dll  
/// Text for class MyClass.  
public ref class MyClass {  
   /// <summary>MyMethod is a method in the MyClass class.  
   /// The <paramref name="Int1"/> parameter takes a number.  
   /// </summary>  
   void MyMethod(int Int1) {}  
};  

See Also

XML Documentation