Compartilhar via


<param> (Visual C++)

A marca de <param> deve ser usada no comentário de uma declaração de método para descrever um dos parâmetros para o método.

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

Parâmetros

  • name
    O nome do parâmetro de um método.Envolva-o com aspas simples ou double - marcas.O compilador emite um aviso se não encontrar name.

  • description
    Uma descrição para o parâmetro.

Comentários

O texto para a marca de <param> será exibido em IntelliSense, Pesquisador de objetos, e no relatório da Web de comentário de código.

Compile com /doc para processar comentários de documentação para um arquivo.

Exemplo

// 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 também

Outros recursos

Documentação XML (Visual C++)