<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>checkstyle - Checkstyle 5.3</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="author" content="Checkstyle Development Team" />
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
</head>
<body class="composite">
<div id="banner">
<span id="bannerLeft">
Checkstyle 5.3
</span>
<a href="" id="bannerRight">
<img src="images/logo.png" alt="Checkstyle" />
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
Last Published: 2010-10-19
</div>
<div class="xright">
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>About</h5>
<ul>
<li class="none">
<strong>Checkstyle</strong>
</li>
<li class="none">
<a href="releasenotes.html">Release Notes</a>
</li>
</ul>
<h5>Documentation</h5>
<ul>
<li class="expanded">
<a href="config.html">Configuration</a>
<ul>
<li class="none">
<a href="property_types.html">Property Types</a>
</li>
</ul>
</li>
<li class="expanded">
<a href="running.html">Running</a>
<ul>
<li class="none">
<a href="anttask.html">Ant Task</a>
</li>
<li class="none">
<a href="cmdline.html">Command Line</a>
</li>
</ul>
</li>
<li class="none">
<a href="availablechecks.html">Available Checks</a>
</li>
<li class="expanded">
<a href="checks.html">Standard Checks</a>
<ul>
<li class="none">
<a href="config_annotation.html">Annotations</a>
</li>
<li class="none">
<a href="config_blocks.html">Block Checks</a>
</li>
<li class="none">
<a href="config_design.html">Class Design</a>
</li>
<li class="none">
<a href="config_coding.html">Coding</a>
</li>
<li class="none">
<a href="config_duplicates.html">Duplicate Code</a>
</li>
<li class="none">
<a href="config_header.html">Headers</a>
</li>
<li class="none">
<a href="config_imports.html">Imports</a>
</li>
<li class="none">
<a href="config_javadoc.html">Javadoc Comments</a>
</li>
<li class="none">
<a href="config_metrics.html">Metrics</a>
</li>
<li class="none">
<a href="config_misc.html">Miscellaneous</a>
</li>
<li class="none">
<a href="config_modifier.html">Modifiers</a>
</li>
<li class="none">
<a href="config_naming.html">Naming Conventions</a>
</li>
<li class="none">
<a href="config_regexp.html">Regexp</a>
</li>
<li class="none">
<a href="config_sizes.html">Size Violations</a>
</li>
<li class="none">
<a href="config_whitespace.html">Whitespace</a>
</li>
</ul>
</li>
<li class="expanded">
<a href="extending.html">Extending Checkstyle</a>
<ul>
<li class="none">
<a href="writingchecks.html">Writing checks</a>
</li>
<li class="none">
<a href="writingfilters.html">Writing filters</a>
</li>
<li class="none">
<a href="writinglisteners.html">Writing listeners</a>
</li>
</ul>
</li>
</ul>
<h5>Developers</h5>
<ul>
<li class="none">
<a href="apidocs/index.html">Javadoc</a>
</li>
<li class="none">
<a href="http://sourceforge.net/projects/checkstyle" class="externalLink">Project Page</a>
</li>
<li class="none">
<a href="contributing.html">Contributing</a>
</li>
</ul>
<h5>Project Documentation</h5>
<ul>
<li class="collapsed">
<a href="project-info.html">Project Information</a>
</li>
<li class="collapsed">
<a href="project-reports.html">Project Reports</a>
</li>
</ul>
<a href="http://sourceforge.net/projects/checkstyle" title="SourceForge" class="poweredBy">
<img alt="SourceForge" src="http://sflogo.sourceforge.net/sflogo.php?group_id=29721&type=11" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2><a name="Overview"></a>Overview</h2>
<p>
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.
</p>
<p>
Checkstyle is highly configurable and can be made to support almost
any coding standard. An example configuration file is supplied
supporting the <a href="http://java.sun.com/docs/codeconv/" class="externalLink">Sun Code
Conventions</a>. As well, other sample configuration files are
supplied for other well known conventions.
</p>
<p>
A good example of a report that can be produced using Checkstyle and
<a href="http://maven.apache.org/" class="externalLink">Maven</a> can be <a href="http://maven.apache.org/plugins/maven-checkstyle-plugin/checkstyle.html" class="externalLink">seen here</a>.
</p>
</div>
<div class="section"><h2><a name="Features"></a>Features</h2>
<p>
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.
</p>
<p>
For a detailed list of available checks please refer to the <a href="checks.html">Standard Checks</a> page.
</p>
</div>
<div class="section"><h2><a name="Download"></a>Download</h2>
<p>
The latest release of Checkstyle can be downloaded from <a href="http://sourceforge.net/project/showfiles.php?group_id=29721" class="externalLink">the
SourceForge download page</a>.
</p>
<p>
If you want to live on the bleeding edge, you can <a href="http://sourceforge.net/svn/?group_id=29721" class="externalLink">checkout the current
development code from Subversion</a> and compile yourself.
</p>
</div>
<div class="section"><h2><a name="Related_Tools"></a>Related Tools</h2>
<p>
Checkstyle is most useful if you integrate it in your build process or
your development environment. The distribution includes:
</p>
<ul><li>An <a href="http://ant.apache.org/index.html" class="externalLink">Ant</a> task.</li>
<li>A command line tool.</li>
</ul>
<p>
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. The known plug-ins are:
</p>
<table class="bodyTable"><tr class="a"><th>IDE / Build tool</th>
<th>Main/Initial Author</th>
<th>Available from</th>
<th>Remarks</th>
</tr>
<tr class="b"><td><a href="http://www.eclipse.org" class="externalLink">Eclipse/RAD/RDz</a></td>
<td>David Schneider</td>
<td><a href="http://eclipse-cs.sourceforge.net/" class="externalLink">Eclipse-CS Home
Page</a></td>
<td></td>
</tr>
<tr class="a"><td><a href="http://www.eclipse.org" class="externalLink">Eclipse/RAD/RDz</a></td>
<td>Marco van Meegen</td>
<td><a href="http://www.mvmsoft.de/content/plugins/checkclipse/checkclipse.htm" class="externalLink">Checklipse
Home Page</a></td>
<td></td>
</tr>
<tr class="b"><td><a href="http://www.intellij.com/idea/" class="externalLink">IntelliJ IDEA</a></td>
<td>Jakub Slawinski</td>
<td><a href="http://www.qaplug.com/" class="externalLink">QAPlug</a></td>
<td>Provides quality assurance features.</td>
</tr>
<tr class="a"><td><a href="http://www.intellij.com/idea/" class="externalLink">IntelliJ IDEA</a></td>
<td>James Shiell</td>
<td><a href="http://code.google.com/p/checkstyle-idea/" class="externalLink">Checkstyle-idea Project Page</a></td>
<td>Provides real-time and on-demand scanning.</td>
</tr>
<tr class="b"><td><a href="http://www.intellij.com/idea/" class="externalLink">IntelliJ IDEA</a></td>
<td>Mark Lussier</td>
<td><a href="http://jetstyle.sourceforge.net/" class="externalLink">JetStyle
Project Page</a></td>
<td></td>
</tr>
<tr class="a"><td><a href="http://www.netbeans.org" class="externalLink">NetBeans</a></td>
<td>Petr Hejl</td>
<td><a href="http://www.sickboy.cz/checkstyle/" class="externalLink">Checkstyle Beans</a></td>
<td>
Problems with source code are displayed as annotations of
the source
</td>
</tr>
<tr class="b"><td><a href="http://www.netbeans.org" class="externalLink">NetBeans</a></td>
<td>Paul Goulbourn</td>
<td><a href="http://nbcheckstyle.sourceforge.net" class="externalLink">nbCheckStyle</a></td>
<td></td>
</tr>
<tr class="a"><td><a href="http://www.netbeans.org" class="externalLink">NetBeans</a></td>
<td></td>
<td><a href="http://ammatsun.com/checkstyle4nb.aspx" class="externalLink">Checkstyle4nb</a></td>
<td></td>
</tr>
<tr class="b"><td><a href="http://www.netbeans.org" class="externalLink">NetBeans</a></td>
<td></td>
<td><a href="https://sqe.dev.java.net/" class="externalLink">Software Quality Environment (SQE)</a></td>
<td></td>
</tr>
<tr class="a"><td></td>
<td><a href="http://www.jcoderz.org/" class="externalLink">jCoderZ</a></td>
<td><a href="http://www.jcoderz.org/fawkez/" class="externalLink">fawkeZ</a></td>
<td>Combines multiple tools (CheckStyle, findbugs, PMD, Cobertura, etc.)</td>
</tr>
<tr class="b"><td><a href="http://www.bluej.org" class="externalLink">BlueJ</a></td>
<td>Rick Giles</td>
<td><a href="http://bluejcheckstyle.sourceforge.net/" class="externalLink">bluejcheckstyle
home page</a></td>
<td></td>
</tr>
<tr class="a"><td><a href="http://snowmail.sn.funpic.de/tide/" class="externalLink">tIDE</a></td>
<td></td>
<td>Built in</td>
<td></td>
</tr>
<tr class="b"><td><a href="http://jdee.sourceforge.net/" class="externalLink">Emacs JDE</a></td>
<td>Markus Mohnen</td>
<td>Part of the standard JDEE distribution</td>
<td></td>
</tr>
<tr class="a"><td><a href="http://www.jedit.org/" class="externalLink">jEdit</a></td>
<td>Todd Papaioannou</td>
<td><a href="http://plugins.jedit.org/plugins/?CheckStylePlugin" class="externalLink">JEdit CheckStylePlugin</a></td>
<td></td>
</tr>
<tr class="b"><td><a href="http://www.vim.org" class="externalLink">Vim editor</a></td>
<td>Xandy Johnson</td>
<td><a href="http://vim.sourceforge.net/script.php?script_id=448" class="externalLink">Plugin Homepage</a></td>
<td>Vim file-type plug-in</td>
</tr>
<tr class="a"><td><a href="http://www.krysalis.org/centipede/" class="externalLink">Krysalis Centipede</a></td>
<td>unknown</td>
<td>Checkstyle supported out of the box</td>
<td></td>
</tr>
<tr class="b"><td><a href="http://maven.apache.org/" class="externalLink">Maven</a></td>
<td>Vincent Massol</td>
<td>Checkstyle supported out of the box</td>
<td><a href="http://maven.apache.org/plugins/maven-checkstyle-plugin/checkstyle.html" class="externalLink">example report</a></td>
</tr>
<tr class="a"><td><a href="http://sonar.codehaus.org/" class="externalLink">Sonar</a></td>
<td>Freddy Mallet (initial author)</td>
<td><a href="http://sonar.codehaus.org/" class="externalLink">Sonar Home Page</a></td>
<td><a href="http://nemo.sonar.codehaus.org/" class="externalLink">Demo site</a></td>
</tr>
<tr class="b"><td><a href="http://qalab.sourceforge.net/" class="externalLink">QALab</a></td>
<td>Benoit Xhenseval</td>
<td><a href="http://qalab.sourceforge.net/" class="externalLink">QALab Home Page</a></td>
<td>Supports tracking Checkstyle statistics over time.</td>
</tr>
<tr class="a"><td><a href="http://www.borland.com/jbuilder/" class="externalLink">Borland JBuilder</a></td>
<td>Darrel King</td>
<td><a href="http://www.pautinka.com/" class="externalLink">http://www.pautinka.com/</a></td>
<td></td>
</tr>
<tr class="b"><td><a href="http://www.borland.com/jbuilder/" class="externalLink">Borland JBuilder</a></td>
<td>Henri Tremblay</td>
<td><a href="http://sourceforge.net/projects/jbcheckstyle-pg/" class="externalLink">JBCS Sourceforge Project Page</a></td>
<td></td>
</tr>
<tr class="a"><td><a href="http://www.borland.com/jbuilder/" class="externalLink">Borland JBuilder</a></td>
<td>Angus Chan</td>
<td><a href="http://jbcheckstyle.sourceforge.net" class="externalLink">jbCheckStyle</a></td>
<td>Checkstyle 2.4</td>
</tr>
</table>
<p>
If you have written a plugin for other IDEs, please let us know, so we
can provide a link here.
</p>
</div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">©
2001-2010
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>