Avoid Methods with a very low comment/code ratio | CAST Appmarq

Avoid Methods with a very low comment/code ratio


Rule Definition
Maintainability of the code is facilitated if there is documentation in the code. This rule will ensure there are comments within the Artifact

Remediation
Enrich Artifact code with comments
Related Technologies

Health Factor

  Total Quality Index

Technical Criterion
Documentation - Volume of Comments

About CAST Appmarq

CAST Appmarq is by far the biggest repository of data about real IT systems. It's built on thousands of analyzed applications, made of 35 different technologies, by over 300 business organizations across major verticals. It provides IT Leaders with factual key analytics to let them know if their applications are on track.

Benchmark Statistics

Global Compliance

54.23%

Total Violations
218,358
Total Opportunities
477,040
Average Violations / App.
2,991.21
The compliance score represents 1 minus the ratio between the number of times a rule has been violated compared to the number of opportunities in a set of applications that the rule could have been violated.

Industry Insights

IT & Business Consulting

30.01%

Manufacturing

23.92%

Telecommunications

57.22%

Want more stats? Register now!