Re:Clarity over brevity in variable and method names
by RandallBrown on Monday September 10, 2012 @05:42PM
(#4502423)
Comments are good for the why, not the how.
I've read far too many comments above functions that simply restate exactly what the code is doing or explain what the stupid abbreviated variables mean.
Comments are a tool that should be used sparingly. They definitely have their place and can be used helpfully. I've found that they're easy to screw up though and I try to avoid them.
I've read far too many comments above functions that simply restate exactly what the code is doing or explain what the stupid abbreviated variables mean.
Comments are a tool that should be used sparingly. They definitely have their place and can be used helpfully. I've found that they're easy to screw up though and I try to avoid them.