<paramref> (guide de programmation C#)
<paramref name="name"/>
Paramètres
- name
Nom du paramètre de référence. Mettez le nom entre guillemets doubles (" ").
Notes
La balise <paramref> la balise vous donne un moyen d'indiquer qu'un mot, dans les commentaires du code, par exemple dans un bloc <summary> ou <remarks>, fait référence à un paramètre. Le fichier XML peut être traité pour mettre en forme ce mot d'une manière particulière, en gras ou en italique, par exemple.
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
{
/// <summary>DoWork is a method in the TestClass class.
/// The <paramref name="Int1"/> parameter takes a number.
/// </summary>
public static void DoWork(int Int1)
{
}
/// text for Main
static void Main()
{
}
}
Voir aussi
Référence
Balises recommandées pour commentaires de documentation (Guide de programmation C#)