Sonar Code Quality Testing Essentials

Chapter 7. Refining Your Documentation

In this chapter, we will examine how we can use Sonar to evaluate results on documentation and comments levels in our projects. We will detail Sonar's metrics on documentation and comments size and add rules which govern documentation in the Packt profile. We will go through the process of locating documentation omissions using Sonar widgets and components, and finally we will configure Maven to generate documentation automatically, embedding it inside Sonar using the Sonar Doxygen plugin.

In this chapter, we cover:

• Writing effective documentation
• Documentation metrics definitions
• Overview of Sonar documentation violations
• Locating undocumented code
• Generating documentation automatically

Writing effective documentation ...