codestyle;поставить Javadoc до или после аннотации? - PullRequest
171 голосов
/ 24 июня 2010

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

Ответы [ 4 ]

183 голосов
/ 24 июня 2010

До аннотации, поскольку аннотация - это код, который «принадлежит» классу. См. примеры с 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) {
    ...
}
16 голосов
/ 24 июня 2010

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

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

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

11 голосов
/ 25 октября 2013

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

10 голосов
/ 24 июня 2010

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

...