Partager via

<paramref> balise de documentation

  • Article

La balise <paramref> vous fournit un moyen d’indiquer qu’un mot est un paramètre. Le fichier XML peut être traité pour mettre en forme ce paramètre de façon distincte.

Syntaxe

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

Paramètres

ref-name
Nom du paramètre auquel faire référence. Mettez le nom entre guillemets simples ou doubles. Le compilateur émet un avertissement s’il ne trouve ref-namepas .

Notes

Compilez avec /doc pour traiter les commentaires de documentation dans un fichier.

Exemple

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

Voir aussi

Documentation XML