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

Question

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;

}

714 4

java javadoc coding-style code-documentation annotations

4 ответов:

Comments

Ничего не найдено.

Peter Jaric · Accepted Answer · 2013-09-27 07:37:57

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

perdian · Accepted Answer · 2010-06-24 16:05:01

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

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

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

shadrik · Accepted Answer · 2013-10-25 11:49:37

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

Robby Pond · Accepted Answer · 2010-06-24 15:38:22

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