Self Descriptiveness Compliance

Concept

The "Self Descriptiveness" KPI intends to highlight components in the code which are not well documented. The KPI analyzes the comment on different criteria:

  • Comment Quantity (evaluate the comment size regarding the module complexity)

  • Comment Quality (detection of "commented-out" source code)

  • Comment Style (check for documentation programming rules violations)

  • Comment Header (look for header comment)

Settings

During the project creation, it is possible to enable/disable the criteria in the "self descriptiveness" section.

SWAN sdescr settings
Figure 1. Self Descriptiveness - settings

How to Track Comment Compliance with Squore

Squore provides a dedicated "highlight" which lists the modules and their compliance regarding self descriptiveness criteria.

SWAN sdescr highlights
Figure 2. Self Descriptiveness - Highlights