IT:AD:Code Comments:Examples:Not an Excuse for Convoluted Code [Notes]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

# IT:AD:Code Comments:Examples:Not an Excuse for Convoluted Code #


* [[./|(UP)]]



## Summary ##

The primary argument of code purists for not commenting code is that code should be self-explanatory.

It is important to note that this is a argument from the point of developers -- not the business owner who is actually *paying* for the creation and long term maintenance of the code. 

Code comments allow for the hiring from a larger pool of less skilled developers, *potentially* decreasing the maintenance and ongoing development costs of the software (I said *potentially*, as there is point where less skilled labour adds cost...).

So code comments are good.

But code comments are *not* to be used as an excuse to explain sloppy code.

Follow [[IT/AD/SOLID/]] development patterns in order to keep your methods small, precise, dealing with a single responsibility.