Почему пакет-info.java полезен?

Когда я выполняю CheckStyle по своему проекту Java, он говорит Missing package-info.java file. для некоторых классов, но не всех их. Я не могу действительно выяснить, почему это сообщение появляется только иногда. Кроме того, мои выполнения проекта, превосходные без пакета-info.java.

Что делает пакет-info.java? Мне действительно нужен он для моих проектов Java?

61
задан 28 February 2014 в 16:44

1 ответ

пакет-info.java является файлом Java, который может быть добавлен к любому исходному пакету Java. Это используется для обеспечения информации на уровне "пакета" согласно его имени. Это содержит документацию и аннотации, используемые в пакете.

javadoc пример уже обеспечивается в ответе, ниже части объясняет, как это работает, упаковывают аннотаций.

, Например, в ниже файла это используется для "заменения" происшествием joda.time. DateTime с org.jadira.usertype.dateandtime.joda. PersistentDateTime

@TypeDefs({
    @TypeDef(name = "PersistentDateTime", typeClass = PersistentDateTime.class, defaultForType=DateTime.class)})

package xyz.abc;

import org.hibernate.annotations.TypeDef;
import org.hibernate.annotations.TypeDefs;
import org.jadira.usertype.dateandtime.joda.PersistentDateTime;
import org.joda.time.DateTime; 

Там является многими аннотациями, доступными, с которым может использоваться для выполнения разных вещей на уровне "пакета". Это может быть найдено в https://docs.jboss.org/hibernate/orm/3.5/api/org/hibernate/annotations/package-summary.html

1
ответ дан 31 October 2019 в 15:36

Другие вопросы по тегам:

Похожие вопросы: