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

Je sais que ce n'est pas le plus essentiel de questions, mais je viens de réaliser que je peux mettre de la javadoc bloc de commentaire avant ou après l'annotation. Ce que nous voulons adopter une 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;
}
InformationsquelleAutor Paul McKenzie | 2010-06-24
  1. 186

    Avant l'annotation, depuis l'annotation est un code qui "appartient" à la classe.
    Voir exemples avec javadoc dans la documentation officielle.

    Voici à tout hasard j'ai trouvé dans un autre officiel page Java:

    /**
 * 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) {
    ...
}
    • Également d'intérêt ici - l'annotation est sur la même ligne que les autres qualificatifs pour la méthode. Je n'ai jamais vu qui fait avant, mais il semble suggérer que les annotations doivent être traités comme beaucoup d'autres qualificatifs pour une méthode, et en tant que tel, la javadoc devriez certainement aller de l'avant.
    • Mettre la même annotations sur la même ligne peut rapidement sortir de la main si vous utilisez quelque chose d'annotation-lourds comme Jackson. J'ai mis chaque annotation sur une ligne propre.
    InformationsquelleAutor Peter Jaric
  2. 16

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

    Annotations sont une partie de la code tout javadoc est une partie de la documentation (d'où le nom).

    Donc, pour moi, il semble raisonnable de conserver le code de pièces.

    InformationsquelleAutor perdian
  3. 11

    Il s'agit de readablity. À mon avis, le code est plus lisible avec les Annotations directement au-dessus de la méthode/champ.

    InformationsquelleAutor Robby Pond
  4. 11

    En dehors de la norme de codage, il semble que l'outil javadoc ne pas traiter la java doc commentaires si ils sont placés après les annotations. Fonctionne très bien sinon.

    InformationsquelleAutor shadrik
  5. 0

    Je suis d'accord avec tout ce qui précède. Il peut être utile à d'autres personnes que IntelliJ Idea () le code de modèles de style échouer à la fois faussement positif (quand @throws est correctement spécifié, prévient-il) et faussement négatif (quand @throws n'est pas spécifié, mais devrait être le cas) lors de l'utilisation de RestEasy style annotations. J'ai mis mon javadoc au-dessus de tout le reste, alors annotations, puis le code.

    Voir le rapport de bug ici:
    https://youtrack.jetbrains.com/issue/IDEA-220520

    InformationsquelleAutor Max P Magee