CodingStyleDesignNote

Design Note: Coding Style

Checkstyle

The WiseUI project uses Checkstyle (http://checkstyle.sourceforge.net/) to assure consistent Java code throughout the project. Checkstyle allows to define a set of rules that are checked against your Java code files.

There are Checkstyle-Plugins available for various IDEs:

• Eclipse: http://eclipse-cs.sourceforge.net/
• IntelliJ: http://code.google.com/p/checkstyle-idea/
• Netbeans: http://www.sickboy.cz/checkstyle/download.html

There is also a Maven-Plugin (http://maven.apache.org/plugins/maven-checkstyle-plugin/) available.

Our custom Checkstyle rule set can be found at https://github.com/itm/wiseui/blob/master/build-tools/src/main/resources/wiseui/checkstyle.xml.

You can generate a report based on the Checkstyle rules:

 $ mvn checkstyle:checkstyle

The generated report can be found under: target/site/checkstyle.html.

Or run it on the console:

 $ mvn checkstyle:check