<summary> (JavaScript)
Specifica la descrizione per una funzione o un metodo.
<summary locid="descriptionID">description
</summary>
Parametri
locid
Parametro facoltativo.L'identificatore per informazioni sulla localizzazione della funzione o del metodo.L'identificatore è un membro ID o corrisponde al valore dell'attributo name in un gruppo di messaggi definiti dai metadati di OpenAjax.Il tipo dell'identificatore dipende dal formato specificato nell'elemento <loc> (JavaScript).description
Parametro facoltativo.Una descrizione della funzione o del metodo.
Note
Gli elementi utilizzati per annotare le funzioni, compresi <summary> (JavaScript), <param> (JavaScript) e <returns> (JavaScript), devono essere inseriti nel corpo della funzione prima delle istruzioni.
Esempio
Nell'esempio di codice riportato di seguito viene illustrato come utilizzare l'elemento <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;
}