Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. It automates the process of checking Java code to spare humans of this boring (but important) task. This makes it ideal for projects that want to enforce a coding standard.
Checkstyle is highly configurable and can be made to support almost any coding standard. An example configuration file is supplied supporting the Sun Code Conventions. As well, other sample configuration files are supplied for other well known conventions.
A good example of a report that can be produced using Checkstyle and Maven can be seen here.
Checkstyle can check many aspects of your source code. Historically it's main functionality has been to check code layout issues, but since the internal architecture was changed in version 3, more and more checks for other purposes have been added. Now Checkstyle provides checks that find class design problems, duplicate code, or bug patterns like double checked locking.
For a detailed list of available checks please refer to the Standard Checks and Optional Checks pages.
The latest release of Checkstyle can be downloaded from the SourceForge download page.
If you want to live on the bleeding edge, you can checkout the current development code from CVS and compile yourself.
Checkstyle is most useful if you integrate it in your build process or your development environment. The distribution includes:
Additionally plug-ins are written by third-parties. Some of them are still based on the Checkstyle 2.4 release, although there have been many improvements since then. If you have to use such a plugin, the documentation for Checkstyle 2.4 is still available, but we strongly encourage plugin authors to upgrade. The known plug-ins are:
IDE / Build tool | Main/Initial Author | Available from | Remarks |
---|---|---|---|
David Schneider | Eclipse-CS Home Page | ||
Marco van Meegen | Checklipse Home Page | ||
Mark Lussier | JetStyle Project Page | Checkstyle 3.4 | |
Paul Goulbourn | nbCheckStyle | ||
Borland JBuilder | Darrel King | http://www.pautinka.com/ | |
Henri Tremblay | |||
Angus Chan | Checkstyle 2.4 | ||
Rick Giles | |||
Markus Mohnen | Part of the standard JDEE distribution | ||
Todd Papaioannou | |||
Xandy Johnson | Vim file-type plug-in | ||
unknown | Checkstyle supported out of the box | ||
Vincent Massol | Checkstyle supported out of the box |
Martin Smith has written instructions on how to set-up Checkstyle with the SlickEdit editor.
If you have written a plugin for other IDEs, please let us know, so we can provide a link here.