O'Reilly logo

Sonar Code Quality Testing Essentials by Charalampos Arapidis

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

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 ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required