Предлагаемый порядок аннотаций Java? - PullRequest
15 голосов
/ 12 апреля 2011

Для проектов, интенсивно использующих аннотации Java, есть ли какие-либо предложения по порядку аннотаций? Чтобы унифицировать стиль кода в команде.

Ответы [ 3 ]

9 голосов
/ 12 апреля 2011

Я собираюсь сказать, что нет.Я могу ошибаться в этом.

Я рассуждаю так: есть сотни проектов, у которых есть аннотации, в дополнение к тем, которые были встроены в Java, и те, которые были добавлены в наши IDE (особенно в Eclipse, но я уверен, чтоу других они тоже есть.)

Итак, со всеми этими библиотеками, потенциально конкурирующими за "чью сверху", я сомневаюсь, что они согласятся на стандарт.

Я бы посоветовал вашей команде сесть иПринимайте решения о том, что лучше для вас, ребята.

Факторы, которые я бы учел:

  1. Какие аннотации наиболее важны?Они должны быть около вершины.
  2. Какие аннотации наиболее вероятно указывают на возможные ошибки?Они должны быть около вершины.
  3. Какие аннотации могут быть в каждом методе класса?Они должны быть около дна.
3 голосов
/ 16 января 2015

Хороший вопрос. Это не точная наука, но лично я пытаюсь расположить аннотации от «широкой области» вверху до «узкой области» внизу. Вот пример:

@RadioDomain
@Entity
@Table(name = "receiver")
@ReceiverConstraintCheck
@SuppressWarnings("PMD.ShortVariable")
public class Receiver {
    // ...
}
2 голосов
/ 12 апреля 2011

Если вам необходимо навести порядок в алфавитном порядке?

Без каких-либо знаний об используемых вами аннотациях трудно предложить рациональный порядок. Возможно, лучший порядок подойдет вам и вашей команде лучше; и если да, то если вы задокументируете согласованный заказ, остается только проверить, соответствует ли он согласованному заказу команды.

Поговорив со всей вашей командой, вы, возможно, обнаружите, что вам не нужно их заказывать.

...