Missing comments can increase costs in PHP

CostSoftware AgilityEmbedded Documentation

Missing comments can increase costs in PHP

This code insight searches all the File not respecting the nameing convention.

Functions, interfaces and classes closing bracket should be commented.

Search for corresponding comment pattern :

// end class

// end interface

// end method xxx()

5362

Why you should care

For correctness reasons, the comments must end correctly. Review the comments for all the artifacts in order to always have ending comments.

Business Impacts

It is recommended to avoid these in order to ensure the code is more readable and cost effective.

Cost

CAST recommendations

References

5362

About CAST and Highlight’s Code Insights

Over the last 25 years, CAST has leveraged unique knowledge on software quality measurement by analyzing thousands of applications and billions of lines of code. Based on this experience and community standards on programming best practices, Highlight implements hundreds of code insights across 15+ technologies to calculate health factors of a software.

See featuresHow it works

c