Любой способ автоматически генерировать ВСЕ комментарии Javadoc в Eclipse? - PullRequest
41 голосов
/ 27 марта 2010

Я знаю, что вы можете нажать shift + alt + j, чтобы вставить соответствующий шаблон комментария для текущего блока кода, но есть ли способ позволить затмению просто сойти с ума и сделать целый проект, как этот?

Ответы [ 3 ]

64 голосов
/ 27 марта 2010

Для целого проекта, возможно, нет, но вы можете по крайней мере:

  • перейти к представлению Package Explorer
  • разверните класс, для которого вы хотите создать комментарий (откройте каждый метод)
  • выбрать все открытые элементы в классе из этого дерева Package Explorer
  • alt + shift + J и вуаля: комментарии, сгенерированные для класса и каждого метода

Единственная причина, по которой это нецелесообразно для всего проекта:

  • вам нужно открыть каждый класс, к которому вы хотите добавить комментарии
  • после того, как был прокомментирован первый набор методов, вам все равно придется повторить процесс, если вы написали новые методы.

При этом другой подход описан в статье " Проблема неполных Javadocs " от 30 марта 2010 г., выступающей за расширенный Javadoc вид .

Расширенное представление Javadoc представляет собой агрегатор различных источников информации для одного элемента кода, такого как класс, метод, поле или параметр. Он предназначен для замены существующего Eclipse Javadoc.

alt text

Интересная часть поставляется с другими вкладками в представлении: Директивы и шаблоны подклассов .
Эти вкладки содержат полезную информацию о том, как разработчики обычно расширяют выбранный элемент кода.

  • Вкладка подклассов:

Директивы подклассов - это обобщения часто проводимых наблюдений в примере кода, например "Подклассы Wizard всегда переопределяют его метод addPages()" или "Reimplementors из Dialog.createContents() могут вызывать его супер реализацию".

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-directives-Wizard.png

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-directives-Wizard-addPages.png

  • Вкладка "Шаблоны подклассов"

Шаблоны подклассов пытаются сгруппировать наблюдаемые расширения базового класса в типичные шаблоны расширений, т. Е. Они подгруппируют подклассы по сходству, чтобы найти шаблоны в данных.

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-patterns-ViewerComparator.png

21 голосов
/ 22 ноября 2011

Я также искал инструмент автоматического javadoc для затмения и нашел один с именем JAutodoc .

Этот инструмент генерирует комментарии довольно хорошо и в некоторых местах требует лишь незначительных изменений вручную (если требуется). На мой взгляд, этот инструмент может сэкономить примерно 75% времени, затрачиваемого на написание комментариев.

Вы можете посетить здесь для получения подробных инструкций по загрузке и интеграции его с eclipse.

6 голосов
/ 26 апреля 2010

Есть также этот плагин, который мне еще предстоит попробовать, но выглядит многообещающе: JAutoDoc

...