Avoid Script Functions with a very low comment/code ratio (PHP) | CAST Appmarq

Avoid Script Functions with a very low comment/code ratio (PHP)

CRITICAL

Rule Definition
A very low comment/code ratio makes the source code difficult to read, maintain and test. It is highly recommended to keep this ratio as high as possible.

Remediation
Modify the source code to reduce the number of Script Functions with a very low comment/code ratio.

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

93.97%

Total Violations
3,767
Total Opportunities
62,431
Average Violations / App.
110.79
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

Select from drop-down

37.81%

Insurance

81.00%

Telecommunications

88.38%