Java — соглашение об использовании javadoc вместе с аннотацией метода? [дубликат]

На этот вопрос уже есть ответы здесь:

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

Закрыто 6 лет назад.

У меня есть следующий метод:

   @Override
   public boolean myMethod()
   {
      // do stuff
   }

Если я хочу добавить javadoc для этого метода, существует ли соглашение о том, как это сделать вместе с аннотацией @Override (или любой другой аннотацией)?

Причина, по которой я спрашиваю, заключается в том, что я читал, что комментарии javadoc ДОЛЖНЫ быть непосредственно перед методом (без новой строки между ними), и я не уверен, что размещение комментария javadoc непосредственно над аннотацией @Override испортит ситуацию. вверх.

Будет ли это, например, обычным способом? Это работает?

   /**
    * This is my method's javadoc comment.
    */
   @Override
   public boolean myMethod()
   {
      // do stuff
   }

задан Tim 25 March 2012 в 20:04

0 ответов

Другие вопросы по тегам:

annotations java javadoc

Java — соглашение об использовании javadoc вместе с аннотацией метода? [дубликат]

0 ответов

Похожие вопросы: