Дублирование комментария тега @return Javadoc необходимо?

Для функций, которые не изменяют состояние экземпляра, комментарий javadoc для метода часто совпадает или очень похож на комментарий для тега @return-в Java-АПИ.

boolean Collection.isEmpty()

  • Возвращает true, если эта коллекция не содержит элементов.
  • Возвращает:true, если эта коллекция не содержит элементов

Теперь я пишу javadoc для многих простых методов, таких как getExpression(), где у меня та же проблема. Должен ли я сделать это как в API или оставить его?

32
задан Roland 28 July 2017 в 08:58
поделиться