Apparently not about two years ago, which is when I wrote this code:

What does this code do anyway? No Comment!

I know what it does, and I know that it works but recently I was required to show how it works. Now, I know I’ve done some work to optimize this code, and often that means sacrificing readability. Working backwards to a point where I could show how the code works took some effort and a considerable amount of time. If I had added meaningful comments when I wrote and understood that code I would have been able to direct that time and effort at something more useful.

This has inspired what may become a new thread in this blog; A Hypocrites Guide to Comments gives advice on commenting from someone who is truly rubbish at it, but who is trying to get better.

Advice on how to add comments and how not to coming as soon as I figure it out for myself ;).

Advertisements