Uncommented Classes increase costs
Count one violation each time a class do not have a docstring as first instruction: bad :
class CustomException
(Exception)
:
def __init__
(self, msg, code)
:
self.msg = msg
self.code = code
good:
class CustomException
(Exception)
:
"""Raise when some custom event did not occur."""
def __init__
(self, msg, code)
:
self.msg = msg
self.code = code
Why you should care
Docstrings help you remember the intention of a class. This is especially important as your codebase grows and it becomes harder to remember the implementation details of each object. Other developers will also have it easier to understand your code.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/maintainability/Consider%20documenting%20your%20class%28es%29/5ZdRTEshAbout 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_uncommentedartifact-avoid-uncommented-classes/
https://doc.casthighlight.com/alt_uncommentedartifact-avoid-uncommented-classes/
Comments