<summary> (JavaScript)
Spécifie la description pour 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 la méthode.L'identificateur est soit un membre ID soit il correspond à la valeur d'attribut name dans un paquet de message défini par les métadonnées d'OpenAjax.Le type d'identificateur dépend du format spécifié dans l'élément <loc> (JavaScript).description
Optionnel.Description de la fonction ou méthode.
Notes
Les éléments utilisés pour annoter des fonctions, qui comprennent <summary> (JavaScript), <param> (JavaScript), et <returns> (JavaScript), doivent être placés dans le corps de la fonction avant les instructions.
Exemple
Le code suivant montre comment utiliser l'élément <summary>.
function areaFunction(radiusParam)
{
/// <summary>Determines the area of a circle when supplied a radius parameter.</summary>
/// <param name="radiusParam" type="Number">The radius of the circle.</param>
/// <returns type="Number">The area.</returns>
var areaVal;
areaVal = Math.PI * radiusParam * radiusParam;
return areaVal;
}