Я использую javadoc для документирования своих классов и методов. Я хотел бы также добавить некоторую обзорную информацию в свои пакеты. Мне нравится, как Eclipse создает заглушку соответствующего Doc Comment для каждого класса или метода после ввода /**<Enter>. У Eclipse есть простой способ создать package.html файл?
Можно ли легко добавить JavaDoc в пакет с помощью Eclipse?
Ответ 1
Обновление через 4 года (октябрь 2013 г.)
javabeangrinder answer (upvoted) упоминает следующий трюк:
Чтобы создать файл
package-info.javaв существующем пакете:
- Щелкните правой кнопкой мыши пакет, в котором вы хотите
package-info.java. - Выберите
new->package. - Установите флажок
Create package.info.java. - Нажмите
Finish
Оригинальный ответ (май 2009 г.)
Нет шаблона или мастера для простого создания файла package.html.
Как mmyers в своем комментарии, так как Java1.5, правильный файл для создания будет package-info.java.
Этот файл можно использовать не только для javadocs, но и для аннотации на уровне пакетов (как иллюстрируется здесь).
Существует открытый Bug (# 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 http://jmdoudoux.developpez.com/cours/developpons/java/images/jaxb006.png
Примечание (в ответ на Strawberry комментарий):
- ошибка 77451 (2004!, для package.html)
- ошибка 163633 и ошибка 163926 (2006), для package-info.java)
как пожелать a предварительный просмотр обзора пакета в package-info.java в Javadoc вид.
До сих пор не было предложено/реализовано патч.
Просто не хватает требований для добавления этой функции.
Ответ 2
В eclipse
Так как package-info.java не является допустимым идентификатором для класса, он не может быть создан как класс в Eclipse.
Я обнаружил, что при создании нового пакета есть флажок, чтобы проверить, хотите ли вы package-info.java.
Чтобы создать файл package-info.java в существующем пакете:
- Щелкните правой кнопкой мыши пакет, в котором вы хотите установить package-info.java.
- Выберите новый- > пакет.
- Установите флажок Create package.info.java.
- Нажмите "Готово"
Ответ 3
Плагин JAutodoc отлично справляется с этим, а также все ваши потребности в документации. Установите и настройте плагин и щелкните правой кнопкой мыши пакет и нажмите JAutodoc > Добавить пакет Javadoc
Существуют конфигурации и шаблоны для документации пакетов .java или .html.
Этот плагин также отлично справляется с стандартизацией всех ваших потребностей Javadoc с большой настройкой.
Ответ 4
Там есть плагин, который, кажется, создает файлы package.html. Я не использовал его, но кто-то, кто приземлился здесь, мог бы найти его полезным.