2009-11-21 4 views
177

Можно создать дубликат:
Javadoc template generatorКак я могу генерировать комментарии Javadoc в Eclipse?

Есть ли способ для создания комментариев Javadoc в Eclipse? Если так, то, что это?

+0

Закрытие как обман, потому что ОП указал на поиск ответа на SO: http://stackoverflow.com/questions/1777175/how-can-i-generate-javadoc-comments-in-eclipse/1777177#comment-1662853 – Kev

+0

Я попробовал альтернативный ответ (2 года назад) и ему это не понравилось, так что считайте его дураком или нет. –

+0

Дубликат или нет, это лучший результат, когда googling «eclipse generate javadoc» – Holloway

ответ

317

Для меня /**<NEWLINE> или Сдвиг - АЛЛ - J (или - Alt - J на Mac) подход работает лучше всего.

Мне не нравится видеть комментарии Javadoc в исходном коде, которые были автоматически сгенерированы и не были обновлены с помощью реального контента. Насколько мне известно, такие джавадоки - не что иное, как пустая трафаретность экрана.

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

+14

Чтобы сэкономить место, сложите его! –

+27

@Pascal - я бы предпочел удалить его/их или не сгенерировать в первую очередь. IMO, сгенерированные комментарии javadoc добавляют нулевое значение ... если вы не подсчитали поддельное повышение отношения «комментарий к коду» как «значение». –

+0

Вот что я делаю. –

34

JAutoDoc:

Eclipse плагин для автоматического добавления Javadoc и файлов заголовков в исходном коде. Это необязательно генерирует начальные комментарии от имени элемента с помощью Velocitytemplates для Javadoc и файлов заголовков ...

+1

лучше, чем встроенный alt-shift-j – trusktr

13

На месте, где вы хотите JavaDoc, введите /** < NEWLINE> и это создаст шаблон.

+0

1. Это работает, спасибо. 2. Этот пункт меню не относится ни к одной из перспектив, которые я использую. –

+0

им интересно узнать, какова ваша перспектива – medopal

+1

Генерация Javadoc не генерирует комментарии Javadoc. Он анализирует комментарии Javadoc и генерирует документацию по проекту (обычно HTML). – ebelisle

25

Вы имеете в виду меню Project -> Generate Javadoc?

+0

Этот пункт меню не относится ни к одной из перспектив, которые я использую. –

+0

Это на моем Eclipse, и единственными дополнительными вещами, которые я установил, являются Google Web Toolkit и FindBugs. (Это Ганимед, а не Европа. Может быть, вам нужно обновиться?) –

+0

У меня есть только перспектива gwt, eclipse v 3.5.1 –

72

Shift-Alt-J - полезная комбинация клавиш в Eclipse для создания шаблонов комментариев Javadoc.

Вызов ярлык на объявлении класса, метода или поля создаст шаблон Javadoc:

public int doAction(int i) { 
    return i; 
} 

Нажатие Shift-Alt-J на объявлении метода дает:

/** 
* @param i 
* @return 
*/ 
public int doAction(int i) { 
    return i; 
} 
+22

На Mac, это '⌘-alt-J' – SteveEdson

+2

Вы только что сделали мою жизнь SOOOOO намного лучше! Я буду благодарен вам каждый раз, когда я использую shift-alt-J - и каждый раз, когда я выгляжу блестяще, когда я показываю его коллегам! – Redboots

Смежные вопросы