Overview of Sonar documentation violations
Sonar features a total of 10 rules that cover documentation and comments. Eight of them are of Major severity and two of minor. We are going to convert them all to Major level in order to get a rounded cost at 30 points.
|
Documentation and Comments Profile Distribution | ||
|---|---|---|
|
Severity |
Rules Count |
Cost |
|
Major |
10 |
30 |
|
Total Cost |
30 | |
The rules though, can be further categorized in two main categories:
- Javadoc rules
- Inline comments rules
Javadoc rules
|
Javadoc Rules | ||
|---|---|---|
|
Severity |
Name |
Analyzer |
|
Major |
Undocumented API |
PMD |
|
Major |
Javadoc Method |
Checkstyle |
|
Major |
Javadoc Package |
Checkstyle |
|
Major |
Javadoc Style |
Checkstyle |
|
Major |
Javadoc Type |
Checkstyle |
|
Major |
Javadoc Variable |
Checkstyle |
When adding the following ...
Get Sonar Code Quality Testing Essentials now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
