Difference between revisions of "Checkstyle"

(Created page with "{{Entry |Name=Checkstyle |Short description=Java syntax checker |Full description=Checkstyle is a development tool to help programmers write Java code that adheres to a coding st...")

|Full description=Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard. Its purpose is to automate the process of checking Java code, and to spare humans of this task. The program checks for:

+

|Full description=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 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. An example configuration file is supplied supporting the Sun Code Conventions. As well, other sample configuration files are supplied for other well known conventions.

−

* The file starts with a specified header. This is useful to ensure that a file has a copyright notice.

+

−

* An @author tag exists for class and interface Javadoc comments. This can be turned off.

+

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.

−

* Format of variable names match specified regular

+

−

* expressions. For examp le, can enforce that all static variables must start with &quot;s&quot;.

Revision as of 08:53, 18 March 2012

Checkstyle

https://github.com/checkstyle/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 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. An example configuration file is supplied supporting the Sun Code Conventions. As well, other sample configuration files are supplied for other well known conventions.

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.

The copyright and license notices on this page only apply to the
text on this page. Any software or copyright-licenses or other
similar notices described in this text has its own copyright notice
and license, which can usually be found in the distribution or license
text itself.