Etiqueta de documentación <paramref>

La etiqueta <paramref> ofrece una manera de indicar que una palabra es un parámetro. El archivo XML se puede procesar para dar formato a este parámetro de una forma exclusiva.

Sintaxis

/// <paramref name="ref-name"/>

Parámetros

ref-name
Nombre del parámetro al que se hace referencia. Ponga el nombre entre comillas simples o dobles. El compilador emite una advertencia si no encuentra ref-name.

Comentarios

Compile con /doc para procesar los comentarios de documentación a un archivo.

Ejemplo

// 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) {}
};

Consulte también

Documentación de XML