Partilhar via


Marca de documentação <paramref>

A marca <paramref> fornece uma forma de indicar que uma palavra é um parâmetro. O arquivo XML pode ser processado para formatar esse parâmetro de uma forma distinta.

Sintaxe

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

Parâmetros

ref-name
O nome do parâmetro ao qual você deseja se referir. Coloque o nome entre aspas simples ou duplas. O compilador emite um aviso se não encontrar ref-name.

Comentários

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

Exemplo

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

Confira também

Documentação XML