Codestyle; поставить javadoc до или после аннотации?

Я знаю, что это не самая важная проблема, но я просто понял, что могу поставить блок комментариев 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;
}

Ответы

Ответ 1

Перед аннотацией, поскольку аннотация - это код, который "принадлежит" классу. См. примеры с 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) {
    ...
}

Ответ 2

Я согласен с уже полученными ответами.

Аннотации являются частью кода, а javadoc является частью документации (отсюда и название).

Так что для меня это разумно держать части кода вместе.

Ответ 3

Помимо стандарта кодирования, кажется, что javadoc-инструмент не обрабатывает комментарии java-doc, если они помещаются после аннотаций. В противном случае работает нормально.

Ответ 4

Все сводится к удобочитаемости. По моему мнению, код более читабельен с помощью аннотаций непосредственно над методом/полем.

Ответ 5

Я согласен со всем вышеперечисленным. Другим может быть полезно, чтобы шаблоны стилей кода IntelliJ (Idea) не давали ложно положительный результат (когда @throws указан правильно, он предупреждает) и ложно отрицательный (когда @throws не указан, но должен быть) при использовании аннотаций стиля RestEasy. Я ставлю свои javadocs выше всего остального, затем аннотации, затем код.

Смотрите отчет об ошибке здесь:https://youtrack.jetbrains.com/issue/IDEA-220520