CAST Engineering Dashboard - Violations - False Violation - Avoid Artifacts with high Commented-out Code Lines per Code Lines ratio may appear as a new violation

Purpose

This page provides information on the metric “Avoid Artifacts with high Commented-out Code Lines/Code Lines ratio”, which may appear as a new violation in a dashboard when there is no change in a particular file.

Applicable in CAST Version

Applicable RDBMS

Details

You can get new violations for the rule “Avoid Artifact with high Commented-out Code Lines/Code Lines ratio” even when there has been no code change for a particular file.

Changes in other parts of the code may cause this metric to become activated and show a new violation for an unchanged object.

This rule only gets activated if the following criteria are met :

• The source code must contain more than 20 “clean” comments
• The source code must contain at least 80 artifacts that have more than 10 lines of code

If you did not meet these criteria in a previous analysis, then you would not have a violation for this metric.   If your code has changed so that you now met these criteria, then you will see this as a new violation, possibly on unchanged objects.

You can see more details on this metric, including definition of the terms used in its calculation (like the definition of a “clean” comment) in the metric documentation for your release.

Notes/comments

Ticket # 2367

Related Pages