codestyle; mettre javadoc avant ou après l’annotation?

Je sais que ce n’est pas le plus important des problèmes, mais je viens de me rendre compte que je peux mettre le bloc de commentaires javadoc avant ou après l’annotation. Que voudrions-nous adopter comme norme de codage?

/** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * This is a javadoc comment after the annotation */ private MyOtherClass other; } 

Avant l’annotation, puisque l’annotation est un code qui “appartient” à la classe. Voir des exemples avec javadoc dans la documentation officielle.

Voici un exemple aléatoire que j’ai trouvé dans une autre page Java officielle :

 /** * Delete multiple items from the list. * * @deprecated Not for public use. * This method is expected to be retained only as a package * private method. Replaced by * {@link #remove(int)} and {@link #removeAll()} */ @Deprecated public synchronized void delItems(int start, int end) { ... } 

Je suis d’accord avec les réponses déjà données.

Les annotations font partie du code alors que javadoc fait partie de la documentation (d’où le nom).

Donc, pour moi, il est raisonnable de garder les parties du code ensemble.

En dehors de la norme de codage, il semble que l’outil javadoc ne traite pas les commentaires de doc java s’ils sont placés après les annotations. Fonctionne bien autrement.

Tout se résume à la lisibilité. À mon avis, le code est plus lisible avec les annotations directement au-dessus de la méthode / du champ.