HTML comments do not add to user-friendliness

Software AgilityEmbedded Documentation

Why you should care

Adding comments to the HTML code generally provides assistance to the developer but provides little practical use to the client as it does not increase user-friendliness since having commentaries on the source page could be a bit unnecessary.

Business Impacts

It is recommended to avoid Incorporating HTML comments as it wastes time and resources which makes it hard to justify having them for the client as they would not understand the comments.

CostTime / Effort

CAST Recommendations

How we detect

This code insight shows that HTML comments will be visible for clients since clients generally don’t have a good understanding of the page’s source code. Since useful information for the client should be displayed in the page with the browser, it is unnecessary to place them as commentaries in the source page.


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