Checkstyle development tool

From Opentaps Wiki
Revision as of 19:02, 21 January 2009 by Oandreyev (talk | contribs) (Using Checkstyle development tool with Eclipse)
Jump to navigationJump to search

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.

Using Checkstyle development tool with Eclipse

As first step you have to install the Eclipse Checkstyle Plug-in via the update site.

1. Within Eclipse go to Help->Software Updates->Available Software
1. Create new update site with Add Site... button.
1. Input a name to your liking (for instance Checkstyle Plug-in) and input the following URL:
1. Click your way through the following pages to install the plug-in.

Follow this guide and create opentaps check configuration. Select External Configuration File and choose opentaps check config file location.

Enable Checkstyle for a project as described on

Depending on project size Checkstyle, working as project builder, can occupy a lot of memory. If required resources become a problem you can deactivate it in project properties and still have possibility check source file manually. To do so select Checkstyle->Check Code with Ckeckstyle in Packahe Explorer context menu for any java (or properties) file.