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

Question

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

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

Answer 1

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

Answer 2

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

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

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

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

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

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

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

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

Answer 3

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

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