Maven Checkstyle Plugin

This page provides a space for users to contribute examples, errata, tips and other useful information about the Maven Checkstyle Plugin. Everybody is invited to share his/her thoughts about the plugin to help the community to improve it.

Note: Please do not use this page to report bugs or feature requests. Instead, please fill in an issue in the issue tracking system listed in the official plugin documentation.

Thanks!

– The Maven Team

Examples

Doing this and that:

<project>
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>2.2</version>
        <configuration>
           <!-- your example configuration here -->
        </configuration>
      </plugin>
    </plugins>
  </reporting>
</project>

Checkstyle configuration file

In order to ignore the Externalized String comments generated by eclipse, you could configure Checkstyle in this way:

<module name="TrailingComment">
  <property name="legalComment" value="\$NON-NLS-" />
</module>

FAQ

How do I ...?

You need to ...