Many years ago I had to try to debug a memory manager written by a really talented software engineer, with an interesting take on naming things…
-
He referred to blocks of memory as “cookies”.
-
He had a temporary variable named “handy” because it was handy to have around.
-
He had a second temporary variable that referenced the first one that he called “son_of_handy”.
-
If corruption was detected in a block of memory then it would set the flag “shit_cookie_corrupt”.
-
If too many cookies were corrupt then the system would halt by calling the function “oh_shit_oh_shit_oh_shit”.
-
U nd to rembr tht mny snr devs grw up prgrmng on old hrdwr tht ddn't hv mch mmry & oftn th lang ony allwd shrt var nms anywy. Also thy wr th gen of txtspk fr smlr rsns.
Yngr snr devs pckd up bd hbts frm tht gen.
And here's a sentence that's not squashed to cleanse your palettes / give a sigh of relief because I figure if I need a break from typing like that, you need a break from reading it.
Nmng thngs s hrd.
Hah, I (a Sr developer at the time) once built an entire mapping layer in our ETL system to deal with the fact that our product had long and expressive names for every data point but our scientists used statistical tools that had no autocomplete and choked on variable names longer than 32 chars so they named everything in like 8 chars of disemvoweled nonsense.
Also, can somebody explain this to sysadmins when it comes to naming computers?
I mean programmers can have some weird naming conventions, but I've never met an adult professional programmer who named all his variables after planets or Harry Potter characters or just called everything stuff like ADMUTIL6 or PBLAB03T1 or PBPCD1602.
Nah, always use as lewd names as possible, like really over the top, preferably r34 compliant. And the comments need to be there to explain the fictional stories behind all the names and all the lewdness - and not really to explain what the code does, that's just a common misconception.
If someones dares to look into my code they need to be ready to suffer.
(And no, I'm not a dev, no one in my team can code anything, boss won't give me a an actual dev - and when I write something for other ppl as a favor I make an effort to make the code clean and comments only mildly amusing)
Does anyone have any good advice on variable naming? Here's some of my rules I try to live by:
- camelCase
- use prefixes
- prefixes should be one word followed by an underscore.
- 10 character limit or 3 word limit, not counting the prefix
- functions should be prefixed with the file in which they're defined, ie
utils_FooBar - file names should be one word
- Start Bools with
is - Don't use
notin bool names.- This has farther-reaching implications that will keep you from making confusing code most of the time (I'm sure this will be controversial, but it works no matter what they say)
- start output with
_ - Globals should be
g_VARIABLENAME - use the least amount of words possible
- but being too verbose can draw attention - use this to aide in readability
calc_ImportantValueThatWillDecideTheUsersViewis better thancalc_SumYearsif the variable is more important than the others.
- Even the greatest variable names are not replacements for documentation
- Even the most readable code is not replacement for documentation.
- Force yourself to love documentation.
Edit: I realize I was speaking about function-naming with the prefix stuff.
For variables, I still use prefixes, but for variable type. Even if you define the variables as types, it's still incredibly useful. For instance,
a string is
s_MyName,enumerable is
e_MyType,A number is int or double or whatever
i_MyAgeord_MyWeightThis might be obvious for custom objects, but I'd still do it like this
p_Personorper_Person.Seriously it does make a huge difference
I have never had any patience with variable names when I realize I have to do a 3-way swap: c=a, a=b, b=c. I'm sure there's 40 years of goddamit=a and fml=a in the wake I've left behind me.
I see this a lot less with developers whose companies actually provide decent IDEs. Especially front end devs or older devs who still use text editors.
longVarNamesAreOkToo
