У меня есть следующий метод:
@Override
public boolean myMethod()
{
// do stuff
}
Если я хочу добавить javadoc для этого метода, существует ли какое-либо соглашение о том, как это сделать, а также аннотацию @Override (или любую другую аннотацию)?
Причина, по которой я спрашиваю, заключается в том, что я прочитал, что комментарии javadoc ДОЛЖНЫ быть непосредственно перед этим методом (между ними нет новых строк), и я не уверен, что если комментарий javadoc непосредственно над аннотацией @Override будет беспорядочным вверх.
Будет ли это обычный способ сделать это, например? Это работает?
/**
* This is my method javadoc comment.
*/
@Override
public boolean myMethod()
{
// do stuff
}