Checkstyle
This entry published by the Free Software Foundation.
Checkstyle
http://checkstyle.sourceforge.net/
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:
- Javadoc comments are defined for class, interface, variable and method declarations.
- Javadoc tags for a method match the actual code.
- 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.
- Format of variable names match specified regular
- expressions. For examp le, can enforce that all static variables must start with "s".
- Class/interface names format matches specified regular expressions.
- Format of parameter names match a specified regular expression.
- Variables that are not declared as private or protected.
- Correct use of white space around binary and unary operators. For examp le, x -=- 1; is illegal, whereas x -= -1; is not.
- Ensure {}'s are used for if/while/for/do constructs.
- Lines are not longer than a specified length.
- Lines do not contain tabs. Note: this check can be turned off.
Documentation
User guide included
Related Projects
Licensing
| License | Verified by | Verified on | Notes |
|---|---|---|---|
| LGPL | Janet Casey | 2451961.521 February 2001 |
Leaders and contributors
| Contact(s) | Role |
|---|---|
 Oliver Burn | Maintainer |
Resources and communication
| Audience | Resource type | URI |
|---|---|---|
| Bug Tracking,Developer,Support | mailto:checkstyle@puppycrawl.com |
Software prerequisites
| Kind | Description |
|---|---|
| Required to use | ANTLR (http://www.antlr.org) |
| Required to use | Jakarta regexp package (http://jakarta.apache.org/regexp) |
Click here if you'd like to report a problem or make a suggestion that could
This entry (in part or in whole) was last reviewed on 21 November 2003.
Problem with this listing?
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page “GNU Free Documentation License”.
The copyright and license notices on this page only apply to the text on this page. Any software described in this text has its own copyright notice and license, which can usually be found in the distribution itself.
This page was last modified on 12 April 2011, at 14:24.