Генерация комментариев JavaDoc для существующего кода в Eclipse - PullRequest
11 голосов
/ 04 мая 2010

Я знаю, что можно создавать комментарии для классов, интерфейса и т. Д. На экране мастера при их создании, но я не нашел опции для создания комментариев Javadoc для существующего файла. Возможно ли это?

Спасибо.

Ответы [ 3 ]

17 голосов
/ 04 мая 2010

Команда "Add Javadoc Comment" или "Generate Element Comment" ( Alt + Shift + J ), и она зависит от один элемент, выбранный в данный момент.

Его нельзя применить ко всему файлу. Таким образом, если вы выберете весь класс через представление проводника проекта, вы не сможете сгенерировать все отсутствующие комментарии оттуда.

Но из Project Explorer, как Виталий Федоренко упоминает в комментариях, работает (только что проверил):

Вы должны развернуть класс в Package Explorer, выбрать все элементы и нажать Alt + Shift + J

http://img683.i_mageshack.us/img683/2263/eclipsegenjavadoc.png

6 голосов
/ 04 мая 2010

Если вы хотите держать обе руки на клавиатуре, наберите /** в строке перед методом и нажмите Enter, чтобы сработать:

/**[press enter here]
int avg(int a, int b) throws ArithmeticException {
    ...
}

->

/**
 * 
 * @param a
 * @param b
 * @return
 * @throws ArithmeticException
 */
int avg(int a, int b) throws ArithmeticException {
    ...
}
2 голосов
/ 02 марта 2012

Это https://stackoverflow.com/a/8223484/830945 обеспечивает очень хорошее решение этой проблемы.

Я сам проверил это, и оно очень хорошо работает с затмением. Вам просто нужно щелкнуть правой кнопкой мыши по проекту, а затем выбрать нужную опцию. можно загрузить с http://jautodoc.sourceforge.net/index.html

...