<deprecated> (JavaScript)
Specifica una funzione o un metodo deprecato.
<deprecated
type="deprecate|remove"
locid="descriptionID">description
</deprecated>
Parametri
type
Parametro facoltativo.Specifica se la funzione o il metodo sarà rimosso nelle versioni future, o se la funzione o il metodo è già stato rimosso e che il relativo utilizzo può provocare un errore.Impostare a deprecate per specificare che la funzione o il metodo sarà rimosso nelle versioni future.Impostare a remove per specificare che la funzione o il metodo è già stato rimosso.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 che è stato deprecato.
Note
Gli elementi utilizzati per annotare le funzioni, compresi <deprecated>, devono essere inseriti nel corpo della funzione prima delle istruzioni.Quando si contrassegna una funzione come deprecata, è consigliabile sostituire il relativo elemento <summary> (JavaScript) con l'elemento <deprecated>.
Esempio
Nell'esempio di codice riportato di seguito viene illustrato come utilizzare l'elemento <deprecated>.
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;
}