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

Locating undocumented code

The Comments & Duplications widget inside the project dashboard provides an overview about documentation. From there we can further browse to undocumented classes by clicking on a metric and finally getting down to source code. A typical workflow would be to:

  1. Click on the Comments or the Public Undocumented API metric displayed in the widget.
  2. Select a package to drill down or a class from the list.
    Locating undocumented code

    If you select a class, the source viewer opens up focused on the Source tab. Read on the header of the source viewer and locate the Comments metrics and the Public documented API on the third and fourth column.

  3. Click on the Violations ...

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