codestyle; mettre javadoc avant ou après l'annotation?
Je sais que ce n'est pas le plus vital des problèmes, mais je viens de réaliser que je peux mettre le bloc de commentaires javadoc avant ou après l'annotation. Que voulons-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;
}
4 réponses
Avant l'annotation, puisque l'annotation est un code qui "appartient" à la classe. Voir 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 tandis que javadoc fait partie de la documentation (d'où le nom).
Donc, pour moi, il est raisonnable de garder les parties de code ensemble.
En dehors de la norme de codage, il semble que javadoc tool ne traite pas les commentaires java doc s'ils sont placés après les annotations. Fonctionne très bien sinon.
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.