Partager via

<param> (Guide de programmation C#)

  • Article

Mise à jour : novembre 2007

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

Paramètres

  • name
    Nom d'un paramètre de méthode. Mettez le nom entre guillemets doubles (" ").

  • description
    Description du paramètre.

Notes

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.

Le texte de la balise <param> est affiché dans IntelliSense, dans l'Explorateur d'objets et dans le rapport Web de commentaire de code.

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

Exemple

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <param name="Int1">Used to indicate status.</param>
    public static void DoWork(int Int1)
    {
    }
    /// text for Main
    static void Main()
    {
    }
}

Voir aussi

Concepts

Guide de programmation C#

Référence

Balises recommandées pour commentaires de documentation (Guide de programmation C#)