Методы комментариев и аннотаций ... куда каждый должен идти?

Question

Итак, допустим, у меня есть метод, который содержит аннотацию, такую ​​как:

@Override
public void bar(String x)

Если бы я должен был добавить комментарии Javadoc в этот фрагмент кода, какой метод предпочтительнее?

Либо:

/**
* @param x A string lol
*/
@Override
public void bar(String x)

Или:

@Override
/**
* @param x A string lol
*/
public void bar(String x)

Answer 1

Первый.Аннотация применяется к методу, а не к комментарию.Это также то, что делает большинство IDE, так что в любом случае это самое распространенное.

Answer 2

Мнение: первый метод предпочтительнее.В некотором смысле аннотация и метод принадлежат друг другу сильнее, чем комментарий.

Answer 3

Лично я предпочитаю первое (т. Е. Аннотацию, «касающуюся» сигнатуры метода), так как тогда это код с кодом.

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

Answer 4

Обычно аннотации располагаются на линии (или строках) непосредственно перед методом. Аннотации могут быть немного длинными для размещения в одной строке.

Однако @Override немного особенный. Это эффективно компенсирует язык, не имеющий override. Обычно он располагается на одной строке (хотя вы увидите множество примеров, где это не так).