[nz_btn text="Software Agility" link="http://casthighlight.wpengine.com/software-agility/" target="_self" animate="false" animation_type="ghost" color="black" size="small" shape="rounded" type="normal" hover_normal="fill" hover_ghost="fill" icon="icon-dashboard"][nz_btn text="Embedded Documentation" target="_self" animate="false" animation_type="ghost" color="black" size="small" shape="rounded" type="ghost" hover_normal="fill" hover_ghost="screen" link="http://casthighlight.wpengine.com/category/product/indicators-methodology/code-insights/software-agility/embedded-documentation/" icon="icon-code"]

Why you should care

Avoid (in production code) comments that reveals that the code could not be finalized or not mature.

Business Impacts

It is recommended to avoid these in order to ensure the code is more readable and cost effective.[nz_btn text="Cost" target="_self" animate="false" animation_type="ghost" color="green" size="small" shape="rounded" type="normal" hover_normal="opacity" hover_ghost="fill" link="http://casthighlight.wpengine.com/category/product/indicators-methodology/cost/" icon="icon-office"]

CAST Recommendations

References

[nz_btn text="Style Guide" target="_self" animate="false" animation_type="ghost" color="turquoise" size="small" shape="rounded" type="ghost" hover_normal="fill" hover_ghost="screen" link="https://github.com/Kristories/awesome-guidelines" icon="icon-book"]

How we detect

Count one violation each time one comment bloc (one or more contiguous lines of comment) contains at least one of the following patterns :

two or more successive ! and/or ?.
following expressions : [àa] (v[ée]rifier|faire|voir|revoir)
following keywords : todo, fixme, tbc, tbd, attention
english expressions : to be (verified|done)
english keywords : warning

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.

[nz_btn text="See features" link="http://casthighlight.wpengine.com/outputs-analytics/" target="_self" icon="icon-stats" animate="false" animation_type="ghost" color="black" size="small" shape="rounded" type="normal" hover_normal="fill" hover_ghost="fill"][nz_btn text="How it works" link="http://casthighlight.wpengine.com/how-it-works/" target="_self" icon="icon-cog" animate="false" animation_type="ghost" color="black" size="small" shape="rounded" type="ghost" hover_normal="fill" hover_ghost="fill"]

For reference only. For the complete details please refer the original article
https://doc.casthighlight.com/alt_suspiciouscomments-avoid-suspicious-comments/

Suspicious Comments can increase costs due to their suspicious nature