Skip to content

Checkstyle Introduction

What is Checkstyle?

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.

Checkstyle is highly configurable and can be made to support almost any coding standard.
Example configuration files are supplied supporting the Sun Code Conventions and Google Java Style.

A good example of a report that can be produced using Checkstyle and Maven can be seen here.

Checkstyle can check many aspects of your source code.
It can find class design problems, method design problems, and also has the ability to check code layout and formatting issues.

For a detailed list of available checks, please refer to the Checks page.

Pages