Як генерувати HTML-файли Javadoc в Eclipse?

165

Я написав такі коментарі у стилі Javadoc у коді свого проекту:

/**
 * Description...
 *
 * @param ...
 * @return .....
 */

Як я можу генерувати HTML-файли Javadoc за допомогою IDE Eclipse?

java eclipse javadoc

— ДжейнІ
джерело

зверніться до цього. learnnjava-soa.blogspot.com/2015/06/…

— мадху

234

Project> Generate Javadoc....
У Javadoc command:полі перейдіть, щоб знайти javadoc.exe (зазвичай у [path_to_jdk_directory] \ bin \ javadoc.exe ).
Поставте прапорець поруч із проектом / пакетом / файлом, для якого ви створюєте Javadoc.
У Destination:полі перейдіть, щоб знайти потрібне місце призначення (наприклад, кореневий каталог поточного проекту).
Клацніть Finish.

Тепер ви зможете знайти новостворений Javadoc у папці призначення. Відкрийте index.html .

— Renu P
джерело

1

Чи потрібно встановлювати Java JDK? У мене встановлена Java і можу створювати програми Java в Eclipse ..., але javadoc.exeне існує ніде на моєму диску!

— AlainD

Старий, але в майбутньому, хто може з цим заплутатися, перевірте, чи встановлений у вас JDK на відміну від JRE (який у цьому місці не містить javadoc.exe).

— omoshiroiii

9

Це відповідь на додаток, пов’язана з ОП:

Просте та надійне рішення для додавання коментарів Javadocs в Eclipse:

Перейдіть до Help> Eclipse Marketplace....
Знайдіть "JAutodoc".
Встановіть його та перезапустіть Eclipse.

Щоб скористатися цим інструментом, клацніть правою клавішею класу та клацніть на JAutodoc.

— піонерBhawna
джерело

7

AFAIK, JAutodoc не генерує HTML з існуючих коментарів javadoc (про що запитує запитання), а скоріше допомагає генерувати коментарі Javadoc.

— Амані Кілуманга

3

Відповідь не пов'язана з питанням, але саме це я саме шукав :)

— keya

Eclipse дозволить вам генерувати Javadocs: Project -> Створити Javadocs ...

— pongapundit

Це створить лише javadoc, а не html, про який йдеться.

— Ашиш

5

Ви також можете зробити це з командного рядка набагато легко.

Відкрийте командний рядок із папки / пакета.
З командного рядка запустіть:

javadoc YourClassName.java
Щоб створити пакетні документи для декількох класів:

javadoc * .java

— Шон Дас
джерело

2

Щоб швидко додати Javadoc, використовуйте наступний ярлик:

Windows : alt+ shift+J

Mac : ⌘+ Alt+J

Залежно від обраного контексту, буде надруковано Javadoc. Щоб створити Javadoc, написаний OP, виберіть відповідний метод і натисніть клавіші ескізів.

— Якоб ван Лінген
джерело