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

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

161 голосов
/ 17 декабря 2010

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

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

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

Ответы [ 4 ]

227 голосов
/ 21 февраля 2013

  1. Проект > Создать Javadoc ... .

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

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

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

  5. Нажмите Готово .

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

9 голосов
/ 18 апреля 2014

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

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

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

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

5 голосов
/ 24 января 2017

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

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

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

    javadoc YourClassName.java

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

    javadoc * .java

0 голосов
/ 30 ноября 2016

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

Windows : alt + shift + J

Mac : ⌘ + Доп. + J

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

...