Inline comments can increase costs
Count one violation each time an instruction statement is followed by a comment on the same line. bad : x = y + z # This is a trailing comment that can become hard to read.
good:
# A comment before the actual code, is better readable
x = y + z
Why you should care
According to PEP8, trailing comments can be used but sparsely. To make your code readable, comments should be placed in a separate line, before the actual code. This ensures your comment is always visible and properly formatted.
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/innovation/" icon="icon-office"]
CAST recommendations
References
https://www.quantifiedcode.com/knowledge-base/readability/Avoid%20inline%20comments/2pqEXt6DAbout 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.
For reference only. For the complete details please refer the original article
https://doc.casthighlight.com/alt_inlinecomment-avoid-inline-comments/
https://doc.casthighlight.com/alt_inlinecomment-avoid-inline-comments/
Comments