<summary> (JavaScript)
Określa opis dla funkcji lub metody.
<summary locid="descriptionID">description</summary>
Parametry
locid
Opcjonalne.Identyfikator lokalizacji informacji na temat funkcji lub metody.Identyfikator jest albo członkiem lub identyfikator odpowiada name wartość w wiązce wiadomości definiowane przez metadane OpenAjax atrybutu.Typ identyfikatora zależy od formatu, określonego w <loc> (JavaScript) element.description
Opcjonalne.Opis funkcji lub metody.
Uwagi
Elementy używane w nim adnotacje funkcje, które obejmują <summary> (JavaScript), <param> (JavaScript), i <returns> (JavaScript), muszą być umieszczone w treści funkcji przed wszelkie oświadczenia.
Przykład
Poniższy kod pokazuje, jak używać <summary> element.
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;
}