<summary> (JavaScript)
Určuje popis funkce nebo metody.
<summary locid="descriptionID">description</summary>
Parametry
locid
Nepovinné.Identifikátor lokalizační informace o funkci nebo metodu.Identifikátor je buď členské ID, nebo odpovídá name v balíku zpráv definované metadaty OpenAjax hodnotu atributu.Typ identifikátoru závisí na formátu zadaném v <loc> (JavaScript) prvku.description
Nepovinné.Popis funkce nebo metody.
Poznámky
Prvky použité opatřit funkce, které zahrnují <summary> (JavaScript), <param> (JavaScript), a <returns> (JavaScript), musí být umístěn v těle funkce před všechny příkazy.
Příklad
Následující kód ukazuje způsob použití <summary> prvku.
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;
}