Checkstyle Home Page |
![]() |
Checkstyle Documentation SourceForge Developers Hosted by: |
OverviewCheckstyle 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. After many months of development Checkstyle version 3 has been released. There have been many improvements that we strongly encourage you to upgrade. However if you are stuck on the last 2.4 release, the old documentation is available here. Be sure to read the section about upgrading to 3.0. FeaturesThe things that Checkstyle can check for are:
DownloadThe 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. Upgrading to release 3.xAs of release 3.0 Checkstyle has changed it's configuration system. The configuration file is now an XML file that configures a tree of check modules. The Checkstyle 2 configuration files (based on properties) are not supported in Checkstyle 3. Please consult the documentation to learn about the new configuration file format. Related ToolsCheckstyle 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. Currently they are typically based on the Checkstyle 2.4 release. The known plug-ins are:
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. |
Copyright © 2001-2003 Oliver Burn. All rights Reserved.