<typeparam> (guide de programmation C#)
<typeparam name="name">description</typeparam>
Paramètres
name
Nom du paramètre de type. Mettez le nom entre guillemets doubles (" ").description
Description du paramètre de type.
Notes
La balise <typeparam> doit être utilisée dans le commentaire d'une déclaration de méthode ou de type générique pour décrire un paramètre de type. Ajoutez une balise pour chaque paramètre de type du type ou de la méthode générique.
Pour plus d'informations, consultez Génériques (guide de programmation C#).
Le texte de la balise <typeparam> sera affiché dans IntelliSense, le rapport Web du commentaire de code Object Browser Window.
Compilez avec /doc pour traiter les commentaires de documentation et les placer dans un fichier.
Exemple
// compile with: /doc:DocFileName.xml
/// comment for class
public class TestClass
{
/// <summary>
/// Creates a new array of arbitrary type <typeparamref name="T"/>
/// </summary>
/// <typeparam name="T">The element type of the array</typeparam>
public static T[] mkArray<T>(int n)
{
return new T[n];
}
}
Voir aussi
Référence
Balises recommandées pour commentaires de documentation (Guide de programmation C#)