Note To Self

Jun 17, 2013 13:05

Annotating your code with ## WHY!?!?! is not as helpful as you think.

This post also on dreamwidth (
Read more... )

Leave a comment

Comments 4

navisx June 18 2013, 10:04:18 UTC
Did your code come from a function you copy pasted from a sample or something hence the ## WHY!?!?!

Reply

brown_betty June 18 2013, 15:55:26 UTC
Nope, this is all me!

My best guess is that I spent a long time getting it to work, and then when it did work, I wasn't sure why that worked, and not other things I tried, so I entered this helpful remark.

Reply

navisx June 19 2013, 13:39:40 UTC
A while ago I spent an hour rereading a system build with all my patches and hacks in it trying to figure out why I did everything. Some of my comments were equally mysterious, especially when there were nice logical things like #set up ramdisk, format and mount && #Install libpcap, install card, reinstall libpcap to recompile with card support which made complete sense followed by
#symbolic links
or
#temporary patch, fix this up later

I fear to look in any of the dodgey scripts I've written over the years that are still core to how bits of my lab work

Reply

brown_betty June 19 2013, 15:59:23 UTC
The thing that frustrates me the most about it is that clearly I was thinking ahead enough to leave myself notes, but not enough to leave myself *useful* notes. I hate that "almost smart enough" moment.

Reply


Leave a comment

Up