Defines and provides access to PMD's directory structure. The user defines the location
of the root PMD directory, e.g., /users/userA/PMD. The PMD directory structure provides
the following:
- Organization to simplify PMD's access to files.
- Eliminates dependence of manually updating the Java classpath.
- Permits adding and removing rule sets without updating lists.
The directory structure and contents are the following:
PMD
pmd.properties
rulesets
basic.xml
design.xml
import.xml
com
myCompany
pmd
rules
myRule01.class
myRule02.class
myRule03.class
net
sourceforge
pmd
rules
myNewExperimentalRule.class
The PMD directory is the root directory of all PMD files.
The pmd.properties file contains various information to be defined.
The rulesets directory contains the rule set files and rule class file directories.
A rule set file is a XML file that describes the rule set and its rules. This
information is displayed and maintained in the PMD Viewer. The rule class files are called by PMD
to perform the analysis.
All rule classes, other than the rule classes in pmd.jar, are stored in directory paths
defined by each rule's class name. The Java classpath is appended with the rulesets
directory so that the rule class and any supporting class files may be found.
NOTE: The user's home directory will contain a PMD directory with a user.preferences
file. An entry in the user's preferences will be the path to the PMD root directory
described above.
author:
Donald A. Leckie
since:
September 19, 2002
version:
$Revision: 1.1 $, $Date: 2003/07/29 20:51:58 $ | 