Можно ли автоматически создавать теги Javadoc для всего проекта Eclipse?
Я знаю, что можно использовать '
Но есть ли способ автоматически создавать эти теги для каждого класса во всем проекте? Или даже просто на уровне пакета или класса?
3 ответа
Не то, что я знаю из.
Что бы это было хорошо в любом случае? Автоматически сгенерированные комментарии Javadoc хуже, чем бесполезны; Я бы предпочел, чтобы они не загромождали мой код, и Javadoc предоставит столько информации, даже без комментариев.
Автоматически генерируемый JavaDoc - это боль, потому что другие люди никогда не узнают, что должен делать метод, и вы сами не узнаете об этом, когда вы посмотрите на урок год спустя.
Пожалуйста, прокомментируйте свои методы самостоятельно или не комментируйте метод.
Моя компания использует checkstyle, чтобы заставить работодателей добавлять javadoc. Некоторые работодатели ненавидят комментировать свои методы и просто вводить бессмысленные комментарии. Было бы лучше, если бы они не комментировали, чем бесполезны.
С помощью checkstyle вы можете найти все недокументированные методы, чтобы документировать их в хорошем формате.
Что поможет вам документировать метод init как
"init должен вызываться перед любым другим методом и инициализировать класс ActionDummy"
лучше сказать, что именно сделано
Инициализирует состояние по умолчанию поставщика действий. Некоторые переменные состояния могут быть переопределены слушателем, когда....