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

Question

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

Answer 1

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

javabeangrinder s answer (upvoted) упоминает следующий трюк:

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

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

---

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

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

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

Существует открытая ошибка (# 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.

_{(источник: developpez.com )}

---

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

• ошибка 77451 (2004! Для package.html)
• ошибка 163633 и ошибка 163926 (2006, для package-info.java)

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

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

Answer 2

В затмении

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

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

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

1. Щелкните правой кнопкой мыши по пакету, в котором вы хотите получить package-info.java.
2. Выберите новый-> пакет.
3. Установите флажок Создать package.info.java.
4. Нажмите на Готово

Answer 3

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

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

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

http://jautodoc.sourceforge.net/

Answer 4

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

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