Partager via


<param> (Visual C++)

La balise <param> doit être utilisée dans le commentaire pour une déclaration de méthode afin de décrire l'un des paramètres pour la méthode.

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

Paramètres

  • name
    Nom d'un paramètre de méthode.Mettez le nom entre guillemets simples ou doubles.Le compilateur émet un avertissement s'il ne trouve pas name.

  • description
    Description du paramètre.

Notes

Le texte de la balise d' <param> s'affiche dans Intellisense, Explorateur d'objets, et dans le rapport Web de commentaires du code.

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

Exemple

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

Voir aussi

Autres ressources

Documentation XML (Visual C++)