Теги @author и @version в комментариях к документации перечисления

Question

Должен ли я добавить теги @author и @version в комментарии к документации перечисления? Как писать комментарии к документу для Javadoc Tool говорит

* @author (только классы и интерфейсы, обязательно)

* @version (только классы и интерфейсы), обязательно. См. сноску 1)

, а шаблон комментария документации IDE для перечислений включает @author.

Answer 1

Вы помещаете в Javadoc, все мандаты вашей организации должны быть помещены в Javadoc. В конце концов, это инструмент коммуникации, вы решаете, какие его части вы хотите использовать, а какие нет.

Answer 2

Тип enum является разновидностью класса (а тип аннотации является разновидностью интерфейса).

Таким образом, когда он говорит только о классах и интерфейсах , это фактически означает только типы и включает в себя типы перечисления (но исключает методы, поля, конструкторы и пакеты).