dglenn: Me in poufy shirt, kilt, and Darth Vader mask, playing a bouzouki (vader)
d'Glenn, aka The Human Vibrator ([personal profile] dglenn) wrote in [staff profile] denise 2011-03-30 07:00 am (UTC)

Ayup. It's a big part of the reason the project I'm currently working on is 51% comments, 17% whitespace, 34% code (in the source/script files; not counting the explicitly-documentation files). Okay, part of it is that I babble when I get tired, but most of it is that I want whoever tries to modify it next to be able to make sense of it without the ability to read my mind, so it gets edited instead of ripped-and-replaced ... especially if that next person is just me again in a year. There are fewer "WTF were they thinking?" moments when the comments explain what you were thinking, why you went one way instead of another.

Unless the code pixies f$#% with the comments as well, of course, in which case, well, I'm screwed.

Post a comment in response:

Identity URL: 
Account name:
If you don't have an account you can create one now.
HTML doesn't work in the subject.


If you are unable to use this captcha for any reason, please contact us by email at support@dreamwidth.org

Notice: This account is set to log the IP addresses of everyone who comments.
Links will be displayed as unclickable URLs to help prevent spam.