Checkstyle

This article has multiple issues. Please help or discuss these issues on the talk page. (Learn how and when to remove these template messages) This article relies too much on references to primary sources. Please improve this by adding secondary or tertiary sources. (July 2010) (Learn how and when to remove this template message) This article needs to be updated. Please help update this article to reflect recent events or newly available information. (August 2015) (Learn how and when to remove this template message)

Checkstyle

Stable release	8.45 / July 31, 2021; 5 months ago (2021-07-31)
Repository	github.com/checkstyle/checkstyle
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 is compliant with specified coding rules.

Originally developed by Oliver Burn back in 2001, the project is maintained by a team of developers from around the world.

The current stable release is version 8.45^[2] which is targeted at the Java 8 language.

Advantages and limits[]

The programming style adopted by a software development project can help to ensure that the code is compliant with good programming practices which improve the quality, readability, re-usability of the code and may reduce the cost of development. The checks performed by Checkstyle are mainly limited to the presentation of the code. These checks do not confirm the correctness or completeness of the code.

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 the following:

• Javadoc comments for classes, attributes and methods;
• Naming conventions of attributes and methods;
• The number of function parameters;
• Line lengths;
• The presence of mandatory headers;
• The use of imports, and scope modifiers;
• The spaces between some characters;
• The practices of class construction;
• Multiple complexity measurements.

Usage[]

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

See also[]

• List of tools for static code analysis
• EclipseCS - Eclipse plugin for checkstyle.
• Checkstyle-IDEA - Checkstyle plugin for IntelliJ IDEA and Android Studio
• SevNTU-Checkstyle - extension for EclipseCS with number of check that are not part of checkstyle upstream.
• Checkstyle Addons - Additional Checkstyle checks
• Checkstyle for PHP - a PHP version of Checkstyle

References[]

External links[]

• Official website
• checkstyle on GitHub

This software-engineering-related article is a stub. You can help Wikipedia by .

• v
• t