Static Source Code Analysis Tools: PMD’s Installation and configuration

Windows Requirements:

• Java JRE 1.5 or higher (see section below for Java JRE 1.4 support)
• Winzip or the free 7-zip

Download the latest binary distribution (http://pmd.sourceforge.net/) - i.e., pmd-bin-x.xx.zip

Unzip it into any directory, i.e., d:\pmd\

=============================================================================================================================

Eclipse

To install the PMD plugin for Eclipse:

• Start Eclipse and open a project
• Select "Help"->"Software Updates"->"Find and Install"
• Click "Next", then click "New remote site"
• Enter "PMD" into the Name field and http://sourceforge.net/projects/pmd/files/pmd-eclipse/update-site/ into the URL field
• Click through the rest of the dialog boxes to install the plugin

Alternatively, you can download the latest zip file and follow the aboveprocedures except for using "New local site" and browsing to thedownloaded zip file.

To configure PMD, select "Windows"->"Preferences",then select PMD.

To run PMD, right-click on a project node and select"PMD"->"Check code with PMD".

To run the duplicate code detector, right-click on a project node andselect "PMD"->"Find suspect cut and paste". The reportwill be placed in a "reports" directory in a file called"cpd-report.txt".

To find additional help for other features, please read included help byselecting Help->Help Contents and browse the "How to..." sectionin the "PMD Plugin Documentation" book.

After installing an update, if you get an Exception such as"java.lang.RuntimeException: Couldn't find that class xxxxx", trydeleting the ruleset.xml file in the.metadata/plugins/net.sourceforge.pmd.eclipse directory in your workspace.

To get Eclipse to not flag the @SuppressWarnings("PMD")annotation, look under the menu headings Java -> Compiler ->Errors/Warnings -> Annotations -> Unhandled Warning Token.