Ordre d'annotation Java suggéré?

Question

Pour les projets fortement utilisés pour les annotations Java, y a-t-il une suggestion dans l'ordre d'annotation? Afin d'uniformiser le style de code dans l'équipe.

Answer 1

Je vais dire qu'il n'y en a pas. Je pourrais avoir tort à ce sujet.

Mon raisonnement est qu'il ya des centaines de projets qui ont des annotations, en plus de celles cuites au four en Java, et ceux cuits dans nos environnements de développement (Eclipse en particulier, mais je suis sûr que d'autres ne les ai aussi.)

Donc, avec toutes ces bibliothèques potentiellement compétitives pour "dont en haut" je doute qu'ils seraient d'accord sur une norme.

J'encourage votre équipe à s'asseoir et à prendre des décisions sur ce qui vous convient le mieux.

Facteurs je considère:

1. qui annotatiosn sont les plus importants? Ils devraient être près du sommet.
2. Quelles sont les annotations les plus susceptibles d'indiquer des bogues potentiels? Ils devraient être près du sommet.
3. Quelles sont les annotations susceptibles d'être appliquées à chaque méthode de la classe? Ils devraient être près du fond.

Answer 2

Si vous devez imposer une commande, par ordre alphabétique? Sans une certaine connaissance des annotations que vous utilisez, il est difficile de suggérer un ordre rationnel. Peut-être qu'un meilleur classement conviendrait mieux à vous et à votre équipe; et si c'est le cas, si vous documentez quel est l'ordre convenu, la seule chose qui reste à faire est de vérifier qu'il suit l'ordre convenu par l'équipe.

Après avoir parlé à toute votre équipe, vous pourriez ne pas avoir besoin de les commander après tout.

Answer 3

Bonne question. Ce n'est pas une science exacte mais personnellement j'essaye d'arranger des annotations d'une "portée large" en haut à une "portée étroite" en bas. Voici un exemple:

@RadioDomain 
@Entity 
@Table(name = "receiver") 
@ReceiverConstraintCheck 
@SuppressWarnings("PMD.ShortVariable") 
public class Receiver { 
    // ... 
}