<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- Content Stylesheet for Site -->
<!-- start the processing -->
<!-- ====================================================================== -->
<!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
<!-- Main Page Section -->
<!-- ====================================================================== -->
<html>
<head>
<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type" />
<meta name="author" content="Checkstyle Development Team">
<meta name="email" content="$au.getAttributeValue("email")">
<title>Checkstyle - Checkstyle 4.4</title>
<style type="text/css" media="all">
@import url("./css/cs-layout.css");
@import url("./css/cs-style.css");
</style>
</head>
<body>
<div class="csTopBar">
<div class="csTopBarContents">
<div class="csLeft">
<h1>Checkstyle 4.4</h1>
</div>
<div class="csRight">
<a href="http://checkstyle.sourceforge.net/">
<img src="images/logo.png" alt="Checkstyle Logo" height="70"/>
</a>
</div>
</div>
</div>
<div class="csMiddleContainer">
<div class="csLeftBar">
<div class="csLeftBarContents">
<!-- ============================================================ -->
<!-- start makeNavigationBar -->
<ul>
<li>
<strong>About</strong>
</li>
<li> <a href="./index.html">Checkstyle</a>
</li>
<li>
<strong>Documentation</strong>
</li>
<li> <a href="./releasenotes.html">Release Notes</a>
</li>
<li> <a href="./config.html">Configuration</a>
</li>
<li> <a href="./property_types.html"> Property Types</a>
</li>
<li> <a href="./running.html">Running</a>
</li>
<li> <a href="./anttask.html"> Ant Task</a>
</li>
<li> <a href="./cmdline.html"> Command Line</a>
</li>
<li> <a href="./availablechecks.html">Available Checks</a>
</li>
<li> <a href="./checks.html">Standard Checks</a>
</li>
<li> <a href="./config_javadoc.html"> Javadoc Comments</a>
</li>
<li> <a href="./config_naming.html"> Naming Conventions</a>
</li>
<li> <a href="./config_header.html"> Headers</a>
</li>
<li> <a href="./config_imports.html"> Imports</a>
</li>
<li> <a href="./config_sizes.html"> Size Violations</a>
</li>
<li> <a href="./config_whitespace.html"> Whitespace</a>
</li>
<li> <a href="./config_modifier.html"> Modifiers</a>
</li>
<li> <a href="./config_blocks.html"> Block Checks</a>
</li>
<li> <a href="./config_coding.html"> Coding</a>
</li>
<li> <a href="./config_design.html"> Class Design</a>
</li>
<li> <a href="./config_duplicates.html"> Duplicate Code</a>
</li>
<li> <a href="./config_metrics.html"> Metrics</a>
</li>
<li> <a href="./config_misc.html"> Miscellaneous</a>
</li>
<li> <a href="./optional.html">Optional Checks</a>
</li>
<li> <a href="./config_j2ee.html"> J2EE Checks</a>
</li>
<li> <a href="./extending.html">Extending Checkstyle</a>
</li>
<li> <a href="./writingchecks.html"> Writing checks</a>
</li>
<li> <a href="./writingfilters.html"> Writing filters</a>
</li>
<li> <a href="./writinglisteners.html"> Writing listeners</a>
</li>
<li> <a href="./api/index.html">Javadoc</a>
</li>
<li>
<strong>SourceForge</strong>
</li>
<li> <a href="http://sourceforge.net/mail/?group_id=29721">Mailing Lists</a>
</li>
<li> <a href="http://sourceforge.net/tracker/?atid=397078&group_id=29721&func=browse">Bug Database</a>
</li>
<li> <a href="http://sourceforge.net/tracker/?atid=397081&group_id=29721&func=browse">Feature Requests</a>
</li>
<li>
<strong>Developers</strong>
</li>
<li> <a href="http://sourceforge.net/projects/checkstyle">Project Page</a>
</li>
<li> <a href="http://checkstyle.svn.sourceforge.net/viewvc/checkstyle/">SVN Repository</a>
</li>
<li> <a href="./contributing.html">Contributing</a>
</li>
</ul>
<ul>
<li>
<strong>Hosted by:</strong>
<div align="center">
<p><a href="http://sourceforge.net">
<img src="http://sourceforge.net/sflogo.php?group_id=29721&type=1" width="88" height="31" alt="SourceForge Logo"/></a>
</p>
</div>
</li>
</ul>
<!-- end makeNavigationBar -->
<!-- ============================================================ -->
</div>
</div>
<div class="csMain">
<a id="Overview"></a>
<h2>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/">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/">Maven</a> can be <a href="http://maven.apache.org/checkstyle-report.html">seen here</a>.
</p>
<a id="Features"></a>
<h2>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> and <a href="optional.html">Optional Checks</a> pages.
</p>
<a id="Download"></a>
<h2>Download</h2>
<p>
The latest release of Checkstyle can be downloaded from <a href="http://sourceforge.net/project/showfiles.php?group_id=29721">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">checkout the current
development code from Subversion</a> and compile yourself.
</p>
<a id="Related Tools"></a>
<h2>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">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. If you have to use such a plugin, the
documentation for Checkstyle 2.4 is still <a href="http://checkstyle.sourceforge.net/old-2.4/">available</a>, but
we strongly encourage plugin authors to upgrade. The known plug-ins
are:
</p>
<table>
<tr class="even">
<th valign="top" align="left"
>
IDE / Build tool
</th>
<th valign="top" align="left"
>
Main/Initial Author
</th>
<th valign="top" align="left"
>
Available from
</th>
<th valign="top" align="left"
>
Remarks
</th>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
David Schneider
</td>
<td class="odd"
>
<a href="http://eclipse-cs.sourceforge.net/">Eclipse-CS Home
Page</a>
</td>
<td class="odd"
>
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
Marco van Meegen
</td>
<td class="even"
>
<a href="http://www.mvmsoft.de/content/plugins/checkclipse/checkclipse.htm">Checklipse
Home Page</a>
</td>
<td class="even"
>
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
James Shiell
</td>
<td class="odd"
>
<a href="http://code.google.com/p/checkstyle-idea/">Checkstyle-idea Project Page</a>
</td>
<td class="odd"
>
Provides real-time and on-demand scanning.
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
Mark Lussier
</td>
<td class="even"
>
<a href="http://jetstyle.sourceforge.net/">JetStyle
Project Page</a>
</td>
<td class="even"
>
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
Petr Hejl
</td>
<td class="odd"
>
<a href="http://www.sickboy.cz/checkstyle/">Checkstyle Beans</a>
</td>
<td class="odd"
>
Problems with source code are displayed as annotations of
the source
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
Paul Goulbourn
</td>
<td class="even"
>
<a href="http://nbcheckstyle.sourceforge.net">nbCheckStyle</a>
</td>
<td class="even"
>
</td>
</tr>
<tr class="odd">
<td class="odd"
>
<a href="http://www.borland.com/jbuilder/">Borland JBuilder</a>
</td>
<td class="odd"
>
Darrel King
</td>
<td class="odd"
>
<a href="http://www.pautinka.com/">http://www.pautinka.com/</a>
</td>
<td class="odd"
>
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
Henri Tremblay
</td>
<td class="even"
>
</td>
<td class="even"
>
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
Angus Chan
</td>
<td class="odd"
>
</td>
<td class="odd"
>
Checkstyle 2.4
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
Rick Giles
</td>
<td class="even"
>
</td>
<td class="even"
>
Checkstyle 3.3
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
Markus Mohnen
</td>
<td class="odd"
>
Part of the standard JDEE distribution
</td>
<td class="odd"
>
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
Todd Papaioannou
</td>
<td class="even"
>
</td>
<td class="even"
>
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
Xandy Johnson
</td>
<td class="odd"
>
</td>
<td class="odd"
>
Vim file-type plug-in
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
unknown
</td>
<td class="even"
>
Checkstyle supported out of the box
</td>
<td class="even"
>
</td>
</tr>
<tr class="odd">
<td class="odd"
>
</td>
<td class="odd"
>
Vincent Massol
</td>
<td class="odd"
>
Checkstyle supported out of the box
</td>
<td class="odd"
>
</td>
</tr>
<tr class="even">
<td class="even"
>
</td>
<td class="even"
>
Benoit Xhenseval
</td>
<td class="even"
>
</td>
<td class="even"
>
Supports tracking Checkstyle statistics over time.
</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 class="csBottomBar">
<div class="csBottomBarContents">
Copyright © 2001-2007, Oliver Burn
</div>
</div>
</body>
</html>
<!-- end the processing -->
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
253d50e0122b162d839c0c787af1f0d6
>
files
>
34
