<summary> (JavaScript)
Gibt die Beschreibung für eine Funktion oder Methode an.
<summary locid="descriptionID">description
</summary>
Parameter
locid
Optional.Der Bezeichner für Lokalisierungsinformationen über die Funktion oder Methode.Der Bezeichner ist entweder eine Member-ID, oder er entspricht dem name-Attributwert in einem Meldungsbündel, das von OpenAjax-Metadaten definiert wird.Der Bezeichnertyp hängt vom Format ab, das im <loc> (JavaScript)-Element angegeben ist.description
Optional.Eine Beschreibung der Funktion oder Methode.
Hinweise
Die Elemente, die verwendet werden, um Funktionen, wie unter anderem <summary> (JavaScript), <param> (JavaScript) und <returns> (JavaScript) mit Anmerkungen zu versehen, müssen vor allen Anweisungen in den Funktionstext eingefügt werden.
Beispiel
Im folgenden Codebeispiel wird die Verwendung des <summary>-Elements veranschaulicht.
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;
}