Checking code-with-pmd
- 1. Checking code with PMD To practice this lesson PMD Perspective should be active.
- 2. PMD Perspective Click open Perspective from Top right corner and select “PMD” if you are in other perspective.
- 4. Checking Code With PMD (1) In the Package Explorer; right-click PMD.java (2) select PMD | Check Code (3) Wait for PMD to scan Java code
- 6. ● Violations Outline view is filled with a list of many violations ● In large projects this list could easily grow up to several thousand ● This is one of the reasons PMD allows violations be filtered by priority ● Priority is a configurable attribute of a PMD rule from 1 to 5 Violations are filtered by priority
- 7. Violations priority (1) Error high (2) Error (3) Warning high (4) Warning (5) Information
- 8. Right-click a violation and select Show Details... PMD pops-up a dialog
- 9. Information abstraction You can right click and select PMD | Check Code With PMD for – Project (all violations) – Package (all classes of a package) – Class (only one class)
- 10. PMD | Clear PMD Violations We can clear violation for ● Project ● Package ● Class
- 11. PMD report After running a lengthy violation check it may be desirable to share the findings with peers or store them for later reference. PMD can generate reports in HTML, XML, plain text as well as Comma Separated Value (CSV) formats.
- 12. Right click Project | PMD | Generate Reports PMD creates a folder reports in the Project; Open reportspmd-report.txt All classes and interfaces must belong to a named package Avoid short class names like PMD Each class should declare at least one constructor headerCommentRequirement Required Use explicit scoping instead of the default package private level fieldCommentRequirement Required