Checkstyle

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search
Checkstyle
Checkstyle Logo.png
Stable release
8.17 / April 30, 2018; 9 months ago (2018-04-30)
Repository Edit this at Wikidata
Written inJava
Operating systemCross-platform
TypeStatic code analysis
LicenseLesser GNU General Public License
Websitecheckstyle.sourceforge.net

Checkstyle[1] is a static code analysis tool used in software development for checking if Java source code complies with 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.17[2] which is targeted at the Java 8 language.

Advantages and limits[edit]

The programming style adopted by a software development project can help to ensure that the code complies with good programming practices which improves 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[edit]

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[edit]

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[edit]

References[edit]

  1. ^ "Checkstyle Home Page". 2010. Retrieved 2010-11-02.
  2. ^ "Checkstyle Release Notes". 2019. Retrieved 2019-02-09.

External links[edit]