Welcome to the documentation index for PMD and CPD! This page exposes the contents of the documentation site thematically, which you can further scope down using the blue filter buttons. To navigate the site, you may also use the search bar in the top right, or the sidebar on the left.
Edit me

Getting started

These pages summarize the gist of PMD usage to get you started quickly.

Rule references

Pick your language to find out about the rule it supports.

Writing rules

These pages document the process of writing and testing custom rules and metrics for PMD.

Usage and configuration

Learn how to build effective and versatile rulesets.


If you'd like to help us build PMD, these topics may interest you. See you around!

Tools and integrations

These pages describe solutions that integrate PMD within your build process.

Major contributions