Как создать HTML-файлы Javadoc в Eclipse?

165

Я написал комментарии в стиле Javadoc следующим образом в коде моего проекта:

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

Как создать HTML-файлы Javadoc с помощью Eclipse IDE?

java eclipse javadoc JaneNY
источник
передайте это. learnjava-soa.blogspot.com/2015/06/…
madhu

Ответы:

234

  1. Project> Generate Javadoc....

  2. В Javadoc command:поле найдите файл javadoc.exe (обычно это каталог [path_to_jdk_directory] \ bin \ javadoc.exe ).

  3. Установите флажок рядом с проектом / пакетом / файлом, для которого вы создаете Javadoc.

  4. В Destination:поле найдите нужное место назначения (например, корневой каталог текущего проекта).

  5. Нажмите Finish.

Теперь вы сможете найти только что созданный Javadoc в папке назначения. Откройте index.html .

Рену П
источник
1
Нужно ли устанавливать Java JDK? Я установил Java и могу создавать Java-программы в Eclipse ... но javadoc.exeна моем диске его нет!
AlainD
Старый, но для любого в будущем, кто может быть смущен этим, проверьте, установлен ли у вас JDK, в отличие от JRE (который не содержит javadoc.exe в этом месте).
omoshiroiii
9

Это дополнительный ответ, связанный с ОП:

Простое и надежное решение для добавления комментариев Javadocs в Eclipse:

  1. Перейти к Help> Eclipse Marketplace....
  2. Найдите "JAutodoc".
  3. Установите его и перезапустите Eclipse.

Чтобы использовать этот инструмент, щелкните правой кнопкой мыши на классе и нажмите JAutodoc.

pioneerBhawna
источник
7
AFAIK, JAutodoc не генерирует HTML из существующих комментариев javadoc (о чем просит вопрос), а скорее помогает создавать комментарии javadoc.
Амани Килуманга
3
Ответ не имеет отношения к вопросу, но это именно то, что я искал :)
keya
Eclipse позволит вам генерировать Javadocs: Project -> Generate Javadocs ...
pongapundit
Это будет генерировать только Javadoc, а не HTML, о котором идет речь.
Ашиш
5

Вы также можете сделать это из командной строки намного проще.

  1. Откройте командную строку из папки / пакета.

  2. Из командной строки запустите:

    javadoc YourClassName.java

  3. Для пакетной генерации документов для нескольких классов:

    javadoc * .java

Шон Дас
источник
2

Чтобы быстро добавить Javadoc, используйте следующий ярлык:

Windows : alt+ shift+J

Mac : ⌘+ Alt+J

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

Якоб ван Линген
источник