Какой-либо путь к автоматическому генерирует ВСЕ комментарии Javadoc в Eclipse?

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

43
задан Finbarr 27 March 2010 в 16:39
поделиться

2 ответа

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

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

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

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

При этом другой подход описан в статье « Проблема неполных документов Javadoc » от 30 марта 2010 г., в которой пропагандируется расширенное представление Javadoc .

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

alt text

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

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

директивы подкласса являются обобщением часто сделанных наблюдений в примере кода, например «Подклассы Wizard всегда переопределяют его метод addPages () » или « Реализователи из Диалог.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

65
ответ дан 26 November 2019 в 22:46
поделиться

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

6
ответ дан 26 November 2019 в 22:46
поделиться
Другие вопросы по тегам:

Похожие вопросы: