Compartir a través de


<param> (Visual C++)

La etiqueta <param> se debe utilizar en el comentario de una declaración de método para describir uno de los parámetros del método.

<param name='name'>description</param>

Parámetros

  • name
    Nombre de un parámetro de método.Agregue el nombre entre comillas simples o dobles.El compilador emite una advertencia si no encuentra name.

  • description
    Descripción del parámetro.

Comentarios

El texto de la etiqueta de <param> se mostrará en IntelliSense, Examinador de objetosy, en el informe web de comentarios de código.

Compile con el parámetro /doc para procesar los comentarios de documentación y generar un archivo con ellos.

Ejemplo

// xml_param_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_param_tag.dll
/// Text for class MyClass.
public ref class MyClass {
   /// <param name="Int1">Used to indicate status.</param>
   void MyMethod(int Int1) {
   }
};

Vea también

Otros recursos

Documentación XML (Visual C++)