Miles Nielsen: The Dossier :: Coding Comments and Commentary

Coding Comments and Commentary

Posted by admin on February 27, 2014

“Where do we even start – this is a couple thousand lines of code we wrote... twenty-five years ago.”
--Aaron Pittman (Zak Orth), Revolution S02E14

Technological Singularities aside, when I heard the quoted material I could not help thinking: “In your comments! Use your comments!”

I comment my code because one of three things will happen:

  1. I will get hit by a bus tomorrow
  2. You will not be able to read my mind
  3. Twenty-Five years from now, I will have forgotten what I was thinking twenty-five years ago; I would be having to read the mind of my former self, a completely different person*

Other documentation, like a manual, could also be useful... but I'm an optimist as much as a skeptic.

*Time Lord Grammar Experts get a free pass at providing tense assistance in this matter