<summary> (JavaScript)
Spécifie la description d'une fonction ou une méthode.
<summary locid="descriptionID">description</summary>
Paramètres
locid
Optionnel.L'identificateur pour les informations de localisation sur la fonction ou méthode.L'identificateur est soit un membre ID ou elle correspond à la name valeur dans une offre groupée de message définie par les métadonnées de OpenAjax d'attribut.Le type d'identificateur dépend du format spécifié dans la <loc> (JavaScript) élément.description
Optionnel.Une description de la fonction ou méthode.
Notes
Les éléments utilisés pour annoter les fonctions qui incluent <summary> (JavaScript), <param> (JavaScript), et <returns> (JavaScript), doit être placé dans le corps de la fonction avant toute instruction.
Exemple
Le code suivant montre comment utiliser la <summary> élément.
function areaFunction(radiusParam)
{
/// <summary>Determines the area of a circle when supplied a radius parameter.</summary>
/// <param name="radius" type="Number">The radius of the circle.</param>
/// <returns type="Number">The area.</returns>
var areaVal;
areaVal = Math.PI * radiusParam * radiusParam;
return areaVal;
}