Я знаю, що це не найважливіша з питань, але я просто зрозумів, що можу поставити блок коментарів javadoc до або після анотації. Що б ми хотіли прийняти як стандарт кодування?
/**
* This is a javadoc comment before the annotation
*/
@Component
public class MyClass {
@Autowired
/**
* This is a javadoc comment after the annotation
*/
private MyOtherClass other;
}
Відповіді:
Перед анотацією, оскільки анотація - це код, який "належить" класу. Дивіться приклади з javadoc в офіційній документації.
Ось випадковий приклад, який я знайшов на іншій офіційній сторінці 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) {
...
}
Я згоден з уже даними відповідями.
Анотації є частиною коду, тоді як javadoc є частиною документації (звідси назва).
Тож для мене вважається розумним зберегти кодові частини разом.
Все зводиться до читабельності. На мій погляд, код легше читається з Анотаціями безпосередньо над методом / полем.
Я згоден з усім вищесказаним. Іншим може бути корисно, що шаблони стилів коду IntelliJ (Idea) не вдається як помилково позитивні (коли @throw вказано правильно, це попереджає), так і помилково негативні (коли @throw не вказано, але має бути) при використанні стилю RestEasy анотації Я ставлю свої javadocs над усім іншим, потім анотації, потім код.
Дивіться звіт про помилки тут: https://youtrack.jetbrains.com/issue/IDEA-220520