O'Reilly logo

SonarQube in Action by G. Ann Campbell and Patroklos P. Papapetrou

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

Chapter 5. Optimizing source code documentation

This chapter covers

  • To document or not?
  • The metrics of commenting
  • Identifying undocumented code
  • Simplifying your documentation strategy

You’re probably wondering why documentation is a topic in a book about a software quality tool. First, let’s be clear. This chapter isn’t about technical documentation or user/administration guides. It’s not even about design or requirements artifacts. It’s all about understanding your source code. And because code understandability has a direct connection with quality, comments and documentation form one of SonarQube’s seven Axes of Quality.

In this chapter, we’ll look at what kinds of metrics are computed for comments and documentation. You’ll see how ...

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