-- Introduction --
The eclipse-cs Checkstyle plug-in integrates the well-known source code analyzer
Checkstyle into today's leading IDE - Eclipse.
Checkstyle is a development tool
written by Oliver Burn to help you ensure that your Java code adheres to a set of coding
standards. Checkstyle does this by inspecting your Java source code and pointing out
items that deviate from a defined set of coding rules. The full Checkstyle distribution
is included with the Checkstyle plug-in. In addition to using the Eclipse Checkstyle
plug-in you can also use Checkstyle from the command line or as part of an Ant build.
For more information about using Checkstyle outside of Eclipse see the Checkstyle documentation.
With the Checkstyle Eclipse plug-in your code is constantly inspected for problems.
Within the Eclipse workbench you are notified of problems via the Eclipse Problems View
and source code annotations just as you would see with compiler errors or warnings.
|
The Eclipse Checkstyle plug-in won the Eclipse
Community Award 2007 in the category of "Best Open Source Eclipse-based
Developer tool". |
Attention Rational Application Developer (RAD) 6/7 users:
Please read here!
-- Download & Installation --
The first way to install the Eclipse Checkstyle Plug-in is via the update site.
- Within Eclipse go to
Help->Software Updates->Find and Install
- Choose
Search for new features to install
and press
Next
- Create a
New Remote Site...
- Input a name to your liking (for instance Checkstyle Plug-in) and input the
following URL: http://eclipse-cs.sourceforge.net/update
- Click your way through the following pages to install the plug-in.
Alternatively the Checkstyle Eclipse Plug-in can be downloaded from the Eclipse Checkstyle Plug-in's
SourceForge project page. The download package consists of a single zip file
that contains both the Checkstyle Plug-in and the Checkstyle core engine.
Once you have downloaded the distribution zip file extract its contents. First, exit from
Eclipse. Next, copy the com.atlassw.tools.eclipse.checkstyle_<version>
folder to your Eclipse plug-in folder and restart Eclipse. That's all there is to it,
you are now ready to run Checkstyle.
Important Note:
If you did not use the update site to install the plug-in please make sure to
restart Eclipse with the -clean option at least once.
This is because Eclipse caches a lot of information about plug-ins. In case you just
updated the plug-in from a previous version this information cached by Eclipse is not up
to date - resulting in the plug-in failing with ClassNotFoundExceptions and other
serious issues.
Important Note:
As of plug-in release 4.0.0 only Eclipse 3.0 and newer is supported. Eclipse 2.x.x
support is discontinued. Please use older plug-in versions with Eclipse 2.x.x. -
downloadable from the SourceForge
Project Page
-- Support this project --
Developing and testing all the nifty features you see in the plug-in takes a considerable
amount of time. This project is developed by its team members purely in their free
time - so we're not in for the money but the fun.
However, if you are using the Checkstyle Plug-in in your production environment you are
probably saving a lot of money because of the increased code quality that the plug-in
helps you to enforce. So if you really like this plug-in you might want to
consider a donation for the Checkstyle Plug-in Project. Donations can my made via
PayPal ranging from $5 to $250. More info about donating to this project can be found here.
Thank you! The Checkstyle Plug-in dev team
-- Donors --
Thank you very much for your donations!
|