Как добавить блок комментариев к методам в Eclipse?

Question

Легко ли добавить блок комментария (стиль Javadoc) к каждому методу в проекте Eclipse и, возможно, к классам, чтобы я мог заполнить их позже?

Answer 1

Как и предполагалось, вы можете сделать это методом для каждого метода (Источник -> Создать комментарий элемента) или ALT+SHIFT+J, но я считаю это очень плохой идеей. Комментарии полезны только тогда, когда они дают дополнительную информацию. Когда вы почувствуете, что нужна дополнительная информация, добавьте ее.

Наличие комментариев к сеттерам, таким как ", устанавливает значение " или, что хуже, автоматически генерируемые комментарии, это вообще не полезно.

Answer 2

Под

Окно |Предпочтения |Java |Код Стиль |Шаблоны кода

вы найдете 2 функции:

• Автоматически добавлять комментарии для новых методов или типов
• Комментарии |Методы |Редактировать ...

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

Answer 3

Чтобы добавить комментарий к методу , выберите getUser или , возьмите курсор перед getUser и нажмите ALT + SHIFT + J Itдобавит комментарий поверх вашего метода

/*
* @param
* @return User
*/
public User getUser();

Answer 4

Простая вещь, вы просто набираете / ** и нажимаете Введите в верхней части метода, где вы хотите сгенерировать комментарий. Он автоматически генерирует комментарий элемента. Не нужно переходить к длинным ключам.

Answer 5

Может быть, вы ищете это

http://jautodoc.sourceforge.net/

Answer 6

пользователей Mac: ⌃ - ⌥ - J

• Опция - 101
• Контроль - 101

Пользователи Windows: Сдвиг - Доп. - J

PS: убедитесь, что у вас установлен JAutodoc плагин

Answer 7

используйте следующие шаги, и вы легко это сделаете в eclipse перейдите в Project -> Generate Javadoc -> нажмите Enter и затем выберите ваш проект для документирования.