Co to jest package-info.java i jak mogę go dodać do mojego projektu?

Question

Kiedy biegnę Checkstyle nad moim projektem wiosennej mówi:

- Missing package-info.java file. 

1. co jest package-info.java i jak to jest przydatne?
2. Jak radzić sobie z tą wiadomością?

Answer 1

Służy do przechowywania opisu javadoc. Można go znaleźć na 7.4.1. Named Packages z JLS:

Zaleca się package-info.java, jeśli jest obecny, zająć miejsce package.html do innych podobnych systemów wytwórczych i dokumentacja javadoc. Jeśli ten plik jest obecny, narzędzie do generowania dokumentacji powinno szukać komentarza w dokumentacji pakietu bezpośrednio poprzedzającego deklarację pakietu (prawdopodobnie opisaną) w dokumencie package-info.java. W ten sposób package-info.java staje się jedynym repozytorium dla adnotacji i dokumentacji na poziomie pakietu. Jeśli w przyszłości pożądane będzie dodawanie innych informacji na poziomie pakietu, ten plik powinien okazać się wygodnym miejscem dla tych informacji.

Przykład:

/** 
* Info about this package doing something for package-info.java file. 
*/ 
package your.project.doSomething; 

Also check this answer

UPDATEfrom here

Pomoc dodając package-info.java do swoich pakietów

While możesz ręcznie dodać pakiet package-info.java do swoich pakietów (tak, jak możesz tworzyć klasy Java ręcznie), IDE często oferują opcję dołączenia pliku package-info.java przy każdym tworzeniu nowego pakietu. Eclipse, pokazany poniżej, oferuje proste (i często pomijane) pole wyboru w kreatorze tworzenia nowego pakietu Java.