<deprecated> (JavaScript)
Especifica uma função ou um método substituído.
<deprecated
type="deprecate|remove"
locid="descriptionID">description
</deprecated>
Parâmetros
type
Opcional.Especifica se a função ou o método serão removidos em uma versão futura, ou se a função ou o método tiverem sido removidos já e que seu uso pode resultar em um erro.Defina a deprecate para especificar que a função ou o método serão removidos em uma versão futura.Defina a remove para especificar que a função ou o método tiverem sido removidos.locid
Opcional.O identificador para informações de localização sobre a função ou método.O identificador é ou um ID do membro ou corresponde ao valor do atributo de name em um pacote de mensagem definida por metadados de OpenAjax.O tipo identificador depende de formato especificado no elemento de <loc> (JavaScript) .description
Opcional.Uma descrição da função ou método que está sendo substituído.
Comentários
Os elementos usados para fazer anotações funções, que incluem <deprecated>, devem ser colocados no corpo da função antes de quaisquer declarações.Quando você marca uma função como substituída, recomendamos que você substitua o elemento de <summary> (JavaScript) com o elemento de <deprecated> .
Exemplo
O código a seguir mostra como usar o elemento de <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;
}