<summary> (JavaScript)
Specifica la descrizione di una funzione o un metodo.
<summary locid="descriptionID">description</summary>
Parametri
locid
Opzionale.Identificatore localizzazione informazioni la funzione o il metodo.L'identificatore è un membro ID o corrisponde alla name valore in un raggruppamento di messaggi definito da metadati OpenAjax di attributo.Il tipo di identificatore dipende dal formato specificato nel <loc> (JavaScript) elemento.description
Opzionale.Descrizione della funzione o metodo.
Note
Gli elementi utilizzati per inserire annotazioni in funzioni che includono <summary> (JavaScript), <param> (JavaScript), e <returns> (JavaScript), deve essere inserito nel corpo della funzione prima delle istruzioni.
Esempio
Il codice riportato di seguito viene illustrato come utilizzare il <summary> elemento.
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;
}