Uncommented functions or methods increase costs

Count one violation each time a function or method do not have a docstring as first instruction:

bad :

              
                def area
                (width, height)
                : 
    return width * height

good:

              
                def area
                (width, height)
                :
    """ Returns the area of a rectangle. """
    return width * height

Why you should care

Docstrings help you remember the intention of a function or method. This is especially important as your codebase grows and it becomes harder to remember the implementation details of each object.

Business Impacts

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

Cost

CAST recommendations

References

https://www.quantifiedcode.com/knowledge-base/maintainability/Consider%20documenting%20your%20class%28es%29/5ZdRTEsh

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 features How it works