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

Question

Je sais que ce n’est pas la plus vitale des questions, mais je viens de réaliser que je peux mettre le bloc de commentaires javadoc avant ou après l’annotation. Ce que nous voulons adopter comme un standard de codage ?

Answer 1

Avant l’annotation, étant donné que l’annotation est code qui « appartient » à la classe. Voir exemples avec javadoc dans la documentation officielle.

Exemple au hasard Voici, j’ai trouvé dans une autre page officielle de Java:

Answer 2

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

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

Donc pour moi il coud raisonnable de garder les parties code ensemble.

Answer 3

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 très bien dans le cas contraire.

Answer 4

Tout cela se résume à readablity. À mon avis le code est plus lisible avec les Annotations directement au-dessus de la méthode/champ.