12
votes

Style de code avec annotations

Je ne peux pas me décider entre xxx

et xxx

y a-t-il une meilleure pratique émergeant?


0 commentaires

5 Réponses :


22
votes

Nous utilisons le premier cas.

annotations ne correspond pas à une ligne dans certains cas .

  • Que se passe-t-il dans ces annotations continuer à s'ajouter à notre projet, à la responsabilité de la responsabilité. Avoir des annotations pour des préoccupations vraiment différentes sur la même ligne devient en désordre.
  • En outre, une annotation peut devenir vraiment grande et être des multi-doublons par eux-mêmes (je pense à la redéfinition de la cartographie hibernate dans une sous-classe).

2 commentaires

Je suis d'accord. Je recommanderais également d'appliquer des annotations dans certains ordonnances fixes. réglé par ordre alphabétique.


Que faites-vous si vous avez comme 10 paramètres d'annotation et que vous faites défiler le passage à droite au-delà de votre longueur de ligne préférée. Pouvez-vous les multi-lignes comme vous le pouvez avec des arguments de la méthode ou non? Je pense que les visiteurs de cette question se demanderont.



1
votes

Eh bien, nous ne pouvons même pas accepter où mettre un {: - (

Ma préférence est la première, surtout comme il peut y avoir plus d'une annotation.

Les exemples que je connais avec utilisez ce style.


0 commentaires

3
votes

Annotations peut avoir des paramètres, il peut devenir très long si vous placez l'annotation plus ses paramètres plus l'en-tête de la méthode sur une ligne.

@MyAnnotation(name = "This is the name", version = "1.0")
public void foo () {
    // ...
}


2 commentaires

Est-il possible de mettre les paramètres d'annotation sur plusieurs lignes telles que vous pouvez faire avec la méthode argways? Ou cela enfreignerait-il l'annotation?


Oui, vous pouvez mettre les paramètres d'annotation sur plusieurs lignes (essayez-la).



3
votes

Je dirais qu'il n'y a pas de règle difficile de la tâche rapide. Vous voudrez peut-être faire soit en fonction de la situation.

Par exemple, si votre classe a un grand groupe de méthodes courtes, il est parfois souhaitable de les condenser sur une ligne pour réduire le bruit de code: P>

@MyAnnotation public int foo1(){ return 1; }
@MyAnnotation public int foo2(){ return 2; }
@MyAnnotation public int foo3(){ return 3; }
etc etc


0 commentaires

1
votes

J'utiliserais généralement le premier cas.

Cependant, une instance particulière où j'ai placé l'annotation sur la même ligne est avec l'annotation @Test dans Junit. Ceci est assez court, ne prend généralement aucun paramètre, et surtout apparaît généralement dans un contexte où un lecteur humain s'attendrait subventionnement à ce qu'il soit là de toute façon. Lorsque vous annotant les méthodes annotant annotant Nulariennes dans une classe d'essai, je dirais que la brièveté supplémentaire de rouler l'annotation dans la même ligne est meilleure (c'est-à-dire moins d'une distraction, peut voir plus de code à l'écran) que de la mettre sur une ligne séparée,

Dans l'affaire Général, vous do veux que vos annotations se distinguent, car ils sont souvent un départ de ce que le développeur s'attendrait à une méthode inannativée. Donc, par exemple, si je définis un délai d'attente sur mon @Test annotation i sera le mettre sur la ligne précédente afin qu'il ne soit pas simplement perdu dans la chaudière.


0 commentaires