Как создать Javadoc HTML в Eclipse?

Я написал комментарии в стиле Javadoc, подобные этому в моем проекте:

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

Как создать Javadoc HTML из Eclipse?

Ответы

Ответ 1

  • Project > Generate Javadoc....

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

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

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

  • Нажмите Finish.

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

Ответ 2

Как создать Javadoc в Eclipse?

  • Откройте папку проекта Eclipse.

  • Выберите Project > Generate Javadoc....

  1. На первом шаге мастера вы можете определить настройки для:

    3,1. Выберите путь для инструмента javadoc.exe из JDK.
    3.2. Ресурсы проекта для создания Javadoc.
    3.3. Классы и методы для создания Javadoc на основе их видимости.
    3.4. Расположение Javadoc (по умолчанию оно будет помещено в папку doc в местоположении проекта).

  1. На втором этапе вы можете выполнить настройки, касающиеся:

    4,1. Название документа.
    4.2. Структура документации.
    4,3. Выберите теги документов, которые нужно обработать.
    4.4. Другие ресурсы (архивы, проекты), используемые в проекте, будут включены в документацию.
    4,5. Выберите таблицу стилей CSS для вашей документации.

  1. На последнем шаге вы можете сохранить настройки в Ant script для дальнейшего использования.

Ответ 3

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

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

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

Ответ 4

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

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

  • Из командной строки:

    javadoc YourClassName.java

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

    javadoc *.java

Ответ 5

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

Windows: alt + shift + J

Mac: ⌘ + alt + J

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