Gostaria de tornar um dos meus métodos "obsoleto" = não usado mais.
Mas ainda assim eu gostaria de tê-lo na minha API. Eu só quero mostrar "aviso" para quem usa esse método.
Como posso conseguir isso?
java
deprecated
Pavel Janicek
fonte
fonte
Respostas:
Use
@Deprecated
no método Não se esqueça de esclarecer o campo javadoc:fonte
reason
com um valor padrão""
não poderia ter prejudicado@deprecated
mensagem no comentário poderia ser adicionado ao@Deprecated
(um local para corrigi-los todos) ...Use a
@Deprecated
anotação e a@deprecated
tag JavaDoc.A
@deprecated
tag JavaDoc é usada para fins de documentação.A
@Deprecated
anotação instrui o compilador que o método está obsoleto. Aqui está o que diz o documento Sun / Oracles sobre o assunto:Você pode encontrar o documento completo em Como e quando descontinuar APIs
fonte
@deprecated
tag javadoc (em Java 4-), o compilador marcou o método (classe, campo) como reprovado e os IDEs mostraram avisos, mesmo quando nenhuma fonte estava disponível.pois faltavam algumas explicações menores
Use
@Deprecated
anotação no método como estelembre-se de explicar:
<br/>
{@link #setPurchasePrice()}
fonte
Há duas coisas que você pode fazer:
@Deprecated
anotação ao método e@deprecated
tag ao javadoc do métodoVocê deve fazer as duas coisas !
Citando o documentação java sobre este assunto:
fonte
Use a anotação
@Deprecated
para seu método e você também deve mencioná-la em seus javadocs.fonte
Dê uma olhada na
@Deprecated
anotação.fonte