Devrais-je utiliser JavaDoc deprecation ou l'annotation en Java?

Question

Il existe à l'heure actuelle, deux façons de marquer code depreacted en java.

Par JavaDoc

/*
 * @deprecated
 */

Ou comme une annotation:

@Deprecated

C'est mon problème, je trouve ça un peu trop à déclarer à la fois, lorsque le marquage d'une méthode obsolète lors de l'utilisation d'Eclipse. Vraiment, je veux juste utiliser l'un d'eux.

Cependant, fait à l'aide de l'annotation donner le compilateur réel des informations utiles?

Mais seulement à l'aide de l'annotation, je ne peux pas dire pourquoi la méthode est obsolète - je ne peux le faire qu'avec JavaDoc, et de la dépréciation d'une méthode sans specying pourquoi est mauvais.

Donc, puis-je utiliser un seul d'entre eux? Ou dois-je vraiment apprendre à spécifier à la fois?

Answer 1

Vous devriez utiliser les deux. L'annotation permet au compilateur d'afficher un avertissement chaque fois qu'une méthode déconseillée est utilisée, et le javadoc explique pourquoi. Les deux sont importants.

Answer 2

De la bouche des chevaux:

REMARQUE: La Spécification du Langage Java nécessite des compilateurs pour émettre des avertissements lorsque les classes, les méthodes, ou les champs marqué avec le @Deprecated annotation sont utilisés. Les compilateurs ne sont pas nécessaires par le Langage Java Spécification de émettre des avertissements lorsque les classes, les méthodes,les ou les champs marqués avec le @deprecated Balise Javadoc sont accessibles, bien que le Soleil compilateurs de le faire actuellement.

Donc en gros, si vous voulez une garantie qu'il y aura des avertissements du compilateur, vous devez utiliser l'annotation. Et à cause de certaines API de designer sont à couper le souffle de l'incompétence, vous devez spécifier la balise javadoc ainsi à donner une explication.

Personnellement, je dirais que l'annotation est inutile et devrait être supprimée jusqu'à ce qu'il fixe, depuis tout bon compilateur ou de l'IDE permettra d'afficher des avertissements avec la javadoc de la balise ainsi.

Answer 3

Vous devriez spécifier les deux.

L'annotation informe le compilateur et déclenche des avertissements lorsque la méthode est utilisée. L'attribut JavaDoc informe les développeurs avant de commencer à l'utiliser.

Ce sont deux choses très différentes!