I have an extreme of the case where seeing what the code
nominally does gives no clue as to why it is being done.
The comment is both accurate and useful. Try
this
on for size...
I guess that is one way to write comments. I worked at a place and read thru their code code and thought it was quite humorous to see stuff like this:
#really need to change this- really sloppy but it works. After the deadline this needs to get fixed.
#damn deadlines- there is no reason for code this sloppy.
#what the hell were we thinking?
and the such.... I was just was just looking for a way to comment professionally.