<deprecated> (JavaScript)
Gibt eine veraltete Funktion oder Methode an.
<deprecated
type="deprecate|remove"
locid="descriptionID">description
</deprecated>
Parameter
type
Optional.Gibt an, ob die Funktion oder Methode in einer zukünftigen Version entfernt wird oder ob die Funktion oder Methode bereits entfernt wurde und ihre Verwendung möglicherweise zu einem Fehler führen wird.Legen Sie es auf deprecate fest, um anzugeben, dass die Funktion oder Methode in einer zukünftigen Version entfernt wird.Legen Sie es auf remove fest, um anzugeben, dass die Funktion oder Methode bereits entfernt wurde.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, die veraltet ist.
Hinweise
Die Elemente, die verwendet werden, um Funktionen, wie unter anderem <deprecated>, mit Anmerkungen zu versehen und müssen vor allen Anweisungen in den Funktionstext eingefügt werden.Wenn Sie eine Funktion als veraltet kennzeichnen, wird empfohlen, ihr <summary> (JavaScript)-Element durch das <deprecated>-Element zu ersetzen.
Beispiel
Im folgenden Codebeispiel wird die Verwendung des <deprecated>-Elements veranschaulicht.
function areaFunction(radiusParam) {
/// <deprecated type="deprecate" >Determines the area of a circle when supplied a radius parameter.</deprecated>
/// <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;
}