PMD is a great and widely-used source code analyzer which finds common programming flaws and bad coding practices in source code projects. This document intends to help users make a better use of this helpful tool, by proposing simple yet effective corrective actions to improve the project quality according to PMD XML results.
The version of PMD used is
5.3.1 and the PMD run was executed on the
PMD raised a total of
4199 violations to checked rules, including:
19with priority 1,
56with priority 2,
4103with priority 3,
21with priority 4.
Rules can be considered as coding practices. They represent what the community believes to be right or wrong, althougth it heavily depends on your own context. In this very case:
87rules have been checked.
45broken rules, and
This plot shows the proportion of rules violated (NOK: red) and clean (OK: blue). The lightness decreases with the priority (P1 -> p4).
Once you have selected the right rules, and made sure you understand them, then you should strive to keep the number of violations low, or even null. For each violation, you should either fix it or acknowledge it. As you will see, there will always be cases where the rule is smart, but doesn't apply to a specific instance in your code â because there is simply no bullet-proof generic truth. But once you know the rules, you know when to bend them, and it is ok: PMD allows you to ignore or suppress the incriminated warnings if you know what you are doing.
There are a few things to keep in mind when using PMD to improve your code:
From there, the next practical thing to do is either to:
The table on the right shows the 10 top files with high-priority violations. NCC P1 is the number of violations with priority 1 in the file, and NCC P2 is the number of violation with priority 2 in the file. Fixing them would be a good start. When you are over, re-run the analysis and fix the 10 next, until all high-priority violations are fixed.
You should start with files that have a lot of high-priority violations. The current analysis unveils:
75violations with priority 1 or 2, distributed in
37files. Those are further decomposed in:
19violations with priority 1, distributed in
56violations with priority 2, distributed in
|File||NCC P1||NCC P2|
|. . ents/src/org/eclipse/gendoc/documents/XMLDocumentService.java||1||7|
|. . src/org/eclipse/gendoc/document/parser/xlsx/XLSXDocument.java||0||8|
|. . ers/src/org/eclipse/gendoc/tags/parsers/impl/AbstractTag.java||4||0|
|. . oc.wizard/src/org/eclipse/gendoc/wizard/GendocWizardPage.java||2||2|
|. . cx/src/org/eclipse/gendoc/services/docx/DOCXImageService.java||0||4|
|. . tml/src/org/eclipse/gendoc/tags/html/impl/ODTHtmlService.java||0||3|
|. . t/src/org/eclipse/gendoc/services/odt/ODTDocumentService.java||0||3|
|. . pse/gendoc/wizard/batch/GendocWizardBatchModeApplication.java||0||3|
|. . c.process/src/org/eclipse/gendoc/process/AbstractProcess.java||2||0|
|. . src/org/eclipse/gendoc/services/xlsx/XLSXDocumentService.java||1||1|
Another approache is to work on practices acquisition: select a few rules that you consider as really important, with an actionable number of violations, and fix them wherever they appear. The current analysis has
5 rules with priority 1 or 2 that show less than 50 violations. The graphic below on the left shows the 5 top rules with a low number of violations and a priority with either 1 or 2. The table on the rigth provides the corresponding data.
The visualisations on this page can be exported and easily reused on an external web site. You can find more information on iframes and pictures reuse in the project's wiki. Remember to change the server name in the code samples provided.
Pie chart of checked and broken rules
<iframe src="http://server/projects/modeling.gendoc/PmdAnalysis/pmd_analysis_pie.html" frameborder="0" style="width: 100%; height: 320px"></iframe>
Files with high priority violations
<img src="http://server/projects/modeling.gendoc/PmdAnalysis/pmd_analysis_files_ncc1.svg" frameborder="0" style="width: 100%; height: 600px" />
Top 5 high-priority rules
<img src="http://server/projects/modeling.gendoc/PmdAnalysis/pmd_analysis_top_5_rules.svg" frameborder="0" style="width: 100%; height: 370px" />
The visualisations used in this document rely on a number of flat CSV and JSON data files, that were extracted from the PMD XML results file. You can download and play with them if you want to thereafter:
Page generated by Alambic 3.3.2 on Mon Apr 23 09:35:29 2018.