Могу ли я легко добавить JavaDoc в пакет с помощью Eclipse?

Я использую javadoc для документирования моих классов и методов. Я также хотел бы добавить некоторую обзорную информацию к своим пакетам. Мне нравится, как Eclipse создает заглушку соответствующего комментария к документу для каждого класса или метода после того, как я набираю /**<Enter>. Есть ли в Eclipse простой способ создания файла package.html , слишком?


eclipse javadoc
person Hanno Fietz    schedule 21.05.2009    source источник
comment
Просто примечание: начиная с Java 1.5, предпочтительным местом для комментариев к пакетам является package-info.java, а не package.html. Таким образом также можно определять аннотации на уровне пакета. См. java.sun.com/javase / 6 / docs / technotes / guides / javadoc /   -  person Michael Myers    schedule 21.05.2009

Ответы (4)


arrow_upward
51
arrow_downward

Обновление 4 года спустя (октябрь 2013 г.)

ответ (за) упоминает следующий трюк:

Чтобы создать package-info.java файл в существующем пакете:

  • Щелкните правой кнопкой мыши пакет, в котором требуется package-info.java.
  • Выберите new->package.
  • Установите флажок Create package.info.java.
  • Нажмите Finish

Оригинальный ответ (май 2009 г.)

Нет шаблона или мастера для простого создания файла package.html.

Как сказал mmyers в своем комментарии, поскольку Java1.5, правильный файл для создания будет _ 7_.
Этот файл можно использовать не только для javadocs, но также и для уровня пакета аннотации (как здесь) .

Существует открытая ошибка (# 86168), требующая мастера для создание package-info.java (поскольку мастер классов не разрешает package-info имя).

Размышления на эту тему продолжаются с ... 2005 года! Проблема в том, что любое решение должно быть реализовано таким образом, чтобы оно также помогало с 1.4 кодом.

Текущий обходной путь - создать package-info.java как файл text.
С этого момента package-info.java ведет себя как обычный класс Java, а Eclipse помещает package-info.class файл в папку вывода.
Javadocs правильно построены с использованием package-info.java , а не файл package.html.

alt text
(источник: developpez.com)

Примечание (в ответ на комментарий Strawberry):

оба желают иметь предварительный просмотр обзора пакета в package-info.java в представлении Javadoc.

Пока не было предложено / внедрено никакого патча.
Просто не хватает требований для добавления этой функции.

person VonC    schedule 21.05.2009
comment
Есть ли способ получить пакет javadocs для отображения в окне быстрого просмотра Javadoc - как это делается для классов, интерфейсов и методов? - person Martin; 19.12.2009
comment
@Strawberry: нет, нет представления Javadoc для package-info.java. См. Мой расширенный ответ по этому поводу. - person VonC; 19.12.2009
comment
На заметку: после этого вопроса мне пришлось пересечь 200 КБ снова! (из-за некоторого пересчета репутации) - person VonC; 10.03.2012
comment
@Mr_and_Mrs_D Действительно хорошее решение. Я включил его и уведомил его автора. - person VonC; 22.10.2013

arrow_upward
15
arrow_downward

В затмении

Поскольку package-info.java не является допустимым идентификатором для класса, он не может быть создан как класс в Eclipse.

Я обнаружил, что при создании нового пакета есть флажок, чтобы проверить, нужен ли вам package-info.java.

Чтобы создать файл package-info.java в существующем пакете:

  1. Щелкните правой кнопкой мыши пакет, в котором вы хотите получить package-info.java.
  2. Выберите новый-> пакет.
  3. Установите флажок Создать package.info.java.
  4. Нажмите Готово
person javabeangrinder    schedule 05.02.2013
comment
Ха-ха, это так интуитивно понятно, спасибо :) Это не отвечает на вопрос, но мне помогло! - person James Bassett; 10.07.2013
comment
+1. По запросу из Mr_and_Mrs_D, я упомянул об этом в своем ответе выше (и проголосовал за ваш). - person VonC; 22.10.2013
comment
В Kepler теперь стоит флажок Create package-info.java. Вы не поверите, но отсутствие дефиса на шаге 3 выше меня немного смутило. - person martin jakubik; 18.04.2014
comment
На Luna это не позволяет мне делать это без указания нового имени пакета. - person Ellen Spertus; 20.11.2014

arrow_upward
13
arrow_downward

Плагин JAutodoc отлично справляется с этой задачей, как и со всей остальной вашей документацией. Установите и настройте плагин, щелкните пакет правой кнопкой мыши и выберите JAutodoc ›Добавить пакет Javadoc.

Существуют конфигурации и шаблоны, доступные для .java или .html документации пакета.

Этот плагин также отлично справляется со стандартизацией всех ваших требований Javadoc с большим количеством настроек.

http://jautodoc.sourceforge.net/

person NathanChristie    schedule 14.01.2011

arrow_upward
3
arrow_downward

Есть плагин, который, кажется, создает файлы package.html. Я не использовал его, но кто-то, кто приземлится здесь, может найти его полезным.

http://sourceforge.net/projects/package-javadoc/

person gMale    schedule 06.01.2010