Когда я запускаю Checkstyle над моим проектом Spring, он говорит:
- Missing package-info.java file.
- что такое package-info.java и как это полезно?
- Как я могу справиться с этим сообщением?
Что такое package-info.java и как я могу добавить его в свой проект?
Ответ 1
Используется для хранения описания Javadoc. Вы можете найти его на 7.4.1. Именованные пакеты of the спецификации языка Java®:
Рекомендуется, чтобы
package-info.javaзаменилpackage.htmlдля javadoc и других подобных систем генерации документации. Если этот файл присутствует, инструмент генерирования документации должен искать комментарий к документации пакета непосредственно перед (возможно, аннотированным) объявлением пакета вpackage-info.java. Таким образом,package-info.javaстановится единственным хранилищем для аннотаций и документации на уровне пакетов. Если в будущем будет желательно добавить какую-либо другую информацию уровня пакета, этот файл должен стать удобным хранилищем этой информации.
Пример:
/**
* Info about this package doing something for package-info.java file.
*/
package your.project.doSomething;
ОБНОВЛЕНИЕ отсюда
Помогите добавить package-info.java в ваши пакеты
В то время как вы можете вручную добавить файл package-info.java в свои пакеты (так же, как вы можете создавать классы Java вручную), в средах разработки часто предлагается возможность включать файл package-info.java каждый раз, когда вы создаете новый пакет., Eclipse, показанный ниже, предлагает простой (и часто пропускаемый) флажок в мастере создания нового пакета Java.
