Version 0.5
Copyright © 2008 - 2009 Lars Vogel
03.08.2009
| Revision History | ||
|---|---|---|
| Revision 0.1 | 18.03.2008 | Lars Vogel |
| Created | ||
| Revision 0.2 - 0.5 | 18.05.2008 - 03.08.2009 | Lars Vogel |
| bugfixed and updates | ||
Table of Contents
Checkstyle checks if the Java code is according to certain standards hence ensuring a certain quality of the coding.
Checkstyle is a tool to help ensuring that your Java code adheres to a set of coding standards
http://eclipse-cs.sourceforge.net/update Update site for the Eclipse Checkstyle Plugin.
Please see Eclipse Update Manager for more information on how to use the update manager.
If you developing with Eclipse, make sure to select the Sun Conventions (Eclipse) under Window -> Preferences -> Checkstyle. Press the "Set as Default" after selecting the right entry.

You can turn of certain checks. If you change settings from the standard profile you should always make a copy of the existing profile.
To customizine your check, first make a copy of the checks

Select your new configuration and press Configure. De-activate for example the checks for Javadoc Comments.

Make this new setting your default one.
For teams it is good to follow the same coding style rules.
The Eclipse checkstyle plugin allows this by proving a remote site for the checkstyle settings.
Press new in the settings. Select "Remote Configuration". Give the rule set a description and then type in the URL you want to use for the settings.

Make this new setting your default one.
Make your new profile the default one.
You need to activate the Eclipse Checkstyle Plugin for your project. Right click on your project and search for Checkstyle. Select the checkbox "Checkstyle active for this project".

You can use the checkstyle browser view to display the violations.

Thank you for practicing with this tutorial.
I maintain this tutorial in my private time. If you like the information please help me by using flattr or donating or by
|
Before posting questions, please see the vogella FAQ . If you have questions or find an error in this article please use the www.vogella.de Google Group . I have created a short list how to create good questions which might also help you. .
http://www.vogella.de/articles/EclipseCodeAnalysis/download/checkstyletemplate.xml My personal Checkstyle settings for Eclipse Plugin Development