<param>
balise de documentation
La balise <param>
doit être utilisée dans le commentaire d’une déclaration de méthode pour décrire l’un des paramètres de la méthode.
Syntaxe
/// <param name='param-name'>description</param>
Paramètres
param-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 param-name
pas .
description
Description du paramètre.
Notes
Le texte de la <param>
balise s’affiche dans IntelliSense, l’Explorateur d’objets et dans le rapport web de commentaire de code.
Compilez avec /doc
pour traiter les commentaires de documentation 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
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour