Checkstyle

Checkstyle
Stable release 6.10.1 / September 1, 2015 (2015-09-01)
Written in Java
Operating system Cross-platform
Type Static code analysis
License Lesser GNU General Public License
Website checkstyle.sourceforge.net

Checkstyle[1] is a static code analysis tool used in software development for checking if Java source code complies with coding rules.

Advantages and limits

The programming style adopted by a software development project can help to comply with good programming practices which improve the code quality, readability, re-usability, and reduce the cost of development. The performed checks mainly limit themselves to the presentation and don't analyze content, and do not confirm the correctness or completeness of the program. In practice, it can be tedious to comply with all the style constraints, some of which could possibly harm the programming stages' dynamic; so, it may be useful to determine which level of check is needed for a certain type of program.

Examples of available modules

Checkstyle defines a set of available modules, each of which provides rules checking with a configurable level of strictness (mandatory, optional...). Each rule can raise notifications, warnings, and errors. For example, checkstyle can examine:

Usage

Checkstyle is built in a JAR file which can run inside a Java VM or as an Apache Ant task. It can also integrate into an IDE or other tools.

A Checkstyle plug-in can provide new functionalities, like:

Thus, the developer can directly access to the code parts highlighted by Checkstyle.

History

Checkstyle, originally developed by Oliver Burn back in 2001, is maintained by a team of several developers around the world.

The current stable release is version 5.7[3] which is targeted towards the Java 7 language.

See also

References

  1. "Checkstyle Home Page". 2010. Retrieved 2010-11-02.
  2. "Checkstyle Duplicate Code Check". 2010. Retrieved 2010-11-02.
  3. "Checkstyle Release Notes". 2014. Retrieved 2014-06-29.

External links

This article is issued from Wikipedia - version of the Thursday, September 03, 2015. The text is available under the Creative Commons Attribution/Share Alike but additional terms may apply for the media files.