Можно ли автоматически создавать теги javadoc для всего проекта Eclipse?

Question

Я знаю, что можно использовать '<alt><shift>J' для создания тегов для одного элемента кода (например, метода класса).

Но есть ли способ автоматически создавать эти теги для каждого класса во всем проекте?Или даже просто на уровне пакета или класса?

Answer 1

Вы посмотрели JAutodoc?

Answer 2

Не то, что я знаю из.

Для чего это вообще было бы полезно?Автоматически сгенерированные комментарии Javadoc более чем бесполезны;Я бы не хотел, чтобы они загромождали мой код, и Javadoc предоставит столько информации, даже без комментариев.

Answer 3

Автоматически сгенерированный JavaDoc - это боль, потому что другие люди никогда не знают, что должен делать метод, и вы сами тоже не узнаете этого, когда посмотрите на класс год спустя.

Пожалуйста, прокомментируйте свои методы самостоятельно или не комментируйте сам метод.

Моя компания использует checkstyle, чтобы заставить работодателей добавлять javadoc.Некоторые работодатели терпеть не могут комментировать свои методы и просто набирают бессмысленные комментарии.Было бы лучше, если бы у них не было комментариев, чем бесполезных.

С помощью checkstyle вы можете найти все недокументированные методы, чтобы задокументировать их в удобном формате.

Что поможет вам задокументировать метод инициализации, например

"init должен быть вызван перед любым другим методом и инициализирует класс ActionDummy"

лучше рассказать, что именно делается

Инициализирует состояние поставщика действий по умолчанию .Некоторые переменные состояния могут быть переопределены прослушивателем, когда ....