PackageAnnotation.md

Pattern: Package annotation not in package-info.java file

Issue: -

Description

This check makes sure that all package annotations are in the package-info.java file.

Java Language Specification (JLS) does not enforce the placement of package annotations. This placement may vary based on implementation. The JLS does highly recommend that all package annotations are placed in the package-info.java file. See Java Language Specification, section 7.4.1.

Examples

To configure the check:

 <module name="PackageAnnotation"/>

Further Reading

• checkstyle - PackageAnnotation