NAME¶
checkstyle - static code analysis tool to check if Java source code complies
with coding rules
SYNOPSIS¶
checkstyle -c configurationFile [options] [file]
OVERVIEW¶
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.
For information about Checkstyle, it can be found at
http://checkstyle.sourceforge.net/.
OPTIONS¶
- file
- Specify the Java source code file to check.
- -c configurationFile
- Specify the file that configures the checks to apply.
- -f format
- Specify the output format. Options are "plain" for the
DefaultLogger and "xml" for the XMLLogger. Defaults to
"plain".
- -p propertiesFile
- Specify a properties file to use.
- -o file
- Specify the file to output to.
- -r dir
- Specify the directory to traverse for Java source files.
SEE ALSO¶
http://checkstyle.sourceforge.net/cmdline.html
