Etiqueta de documentación <param>

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

Sintaxis

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

Parámetros

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

description
Descripción del parámetro.

Comentarios

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

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

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

Consulte también

Documentación de XML