maradydd: (Default)
maradydd ([personal profile] maradydd) wrote2008-07-06 11:30 pm
Entry tags:

[Code Friday] Note to self

Nothing written using Boost is ever self-documenting.

[identity profile] mouser.livejournal.com 2008-07-07 12:26 pm (UTC)(link)
Corollary: Nothing is ever REALLY self-documenting. It just seems like it.

(You don't believe me, look at any code you haven't touched in a year...)
vatine: Generated with some CL code and a hand-designed blackletter font (Default)

[personal profile] vatine 2008-07-07 01:13 pm (UTC)(link)
It actually helps having someone asking you about the code. I had reasons to revisit an old codebase I cobbled together (and basically stoipped working on) Jan-Mar 2007 and once I had had a glance at the code, it wasn't too bad, even if there's almsot no comments (I'd climb out on a limb and say "completely undocumented", but there's a few design docs and at least one protocol spec in the code tree, even if it's not in the code itself).

[identity profile] maradydd.livejournal.com 2008-07-07 10:07 pm (UTC)(link)
Oh, indeed; that's why I adhere to the Next Jackass Principle ("always comment your code thoroughly for the next jackass who will have to maintain it, because 95% of the time, the next jackass is you"). Thanks to the comments, I knew what the routine in question was supposed to be doing; however, it took a couple of minutes to re-grok the template-sludge enough to figure out how. Fixed now.

[identity profile] neoliminal.livejournal.com 2008-07-07 01:48 pm (UTC)(link)
LOL.
lawnrrd: (Default)

[personal profile] lawnrrd 2008-07-07 09:42 pm (UTC)(link)
The phrase that you're looking for is "write-only language."

[identity profile] maradydd.livejournal.com 2008-07-07 10:08 pm (UTC)(link)
And yet I can read Perl. But not write it. Go figure.