Для проектов, сильно используемых аннотаций Java, есть ли какие-либо предложения по порядку аннотации? Так, чтобы унифицировать стиль кода в команде.
Предлагаемый порядок аннотации Java?
Ответ 1
Я скажу, что нет. Я мог бы доказать это неправильно.
Мое рассуждение - это сотни проектов, в которых есть аннотации, в дополнение к тем, которые испечены на Java, и те, которые испечены в наших IDE (в частности, Eclipse, но я уверен, что у других тоже есть их.)
Итак, со всеми этими библиотеками, потенциально конкурирующими за "чьи вершины", я сомневаюсь, что они согласятся на стандарт.
Я бы посоветовал вашей команде сесть и принять решение о том, что лучше всего для вас, ребята.
Факторы, которые я хотел бы рассмотреть:
- Какая аннотация важна? Они должны быть в верхней части.
- Какие аннотации, скорее всего, будут индикативными для потенциальных ошибок? Они должны быть в верхней части.
- Какие аннотации, вероятно, относятся к каждому методу в классе? Они должны быть у основания.
Ответ 2
Если вы должны наложить порядок, в алфавитном порядке?
Без каких-либо знаний об используемых вами аннотациях трудно предложить рациональный порядок. Возможно, лучший порядок подойдет вам и вашей команде лучше; и если да, если вы документируете то, что согласовано, осталось только проверить, соответствует ли он согласованному заказу команды.
После разговора со всей вашей командой вы можете обнаружить, что вам не нужно их заказывать.
Ответ 3
Хороший вопрос. Это не точная наука, но лично я стараюсь выстроить аннотации из "широкой сферы" вверху, чтобы "узкая область" внизу. Вот пример:@RadioDomain
@Entity
@Table(name = "receiver")
@ReceiverConstraintCheck
@SuppressWarnings("PMD.ShortVariable")
public class Receiver {
// ...
}