Partilhar via


<paramref> (Visual C++)

A marca de <paramref> oferece uma maneira para indicar que uma palavra é um parâmetro.O arquivo .xml pode ser processado para formatar este parâmetro em alguma forma distinta.

<paramref name="name"/>

Parâmetros

  • name
    O nome do parâmetro para se referir a ele.Envolva-o com aspas simples ou double - marcas.O compilador emite um aviso se não encontrar name.

Comentários

Compile com /doc para processar comentários de documentação para 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) {}
};

Consulte também

Outros recursos

XML Documentation (Visual C++)