Подтвердить что ты не робот

Любой способ автоматического генерации всех комментариев Javadoc в Eclipse?

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

4b9b3361

ОТВЕТЫ

Ответ 1

Для всего проекта может быть нет, но вы можете хотя бы:

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

Единственная причина, по которой этот проект практически не применим:

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

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

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

alt text

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

  • Вкладка "Подклассы":
Директивы подкласса

являются обобщениями часто сделанных наблюдений в примере кода, например: "Подклассы мастера всегда переопределяют его метод addPages()" или "Reimplementors of 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

Ответ 2

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

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

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

Ответ 3

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