Skip to main content

Why you don't want to code for a government department

Back in the mists of time, straight after my doctorate, I worked for a UK start-up called Madge Networks initially maintaining device drivers that implemented LLC, NetBIOS, IPX/SPX protocols and then writing a TCP/IP stack. Most of this work was done in C and assembler (x86 and TMS380).

When I first joined the company I was sent on an x86 assembly training course run by QA Training. (It rained on the first day and we were locked out so one of the company big cheeses ran over with QA Training umbrellas; to this day I use that umbrella).

During the course we were asked to write a simple function in C. I've forgotten what it was, but let's say it was a classic factorial function. I wrote something like:

unsigned int fac( unsigned int i )
{
if ( i < 2 ) {
return 1;
}

return i * fac( i - 1 );
}

Later we looked at an assembly equivalent of the function, but before that I took at look at the person sitting next to me. His function looked like this:

unsigned int aq456( unsigned int aq457 )
{
if ( aq457 == 0 )
return 1;

if ( aq457 == 1 )
return 1;

return aq457 * aq456( aq457 - 1 );
}

So, naturally I asked him why he used such horrible names for functions and variables .

It turned out that he worked for a government department and all identifiers were allocated and documented before the code was written. Hence, somewhere a document would tell you that aq456 was a factorial function with excruciating detail of its parameters and return values. And also you could discover that aq457 was the parameter for aq456.

He recounted how each project had a unique two letter code (he'd chosen aq as being qa backwards) followed by a sequence number.

He'd chosen aq because all the projects had worked on were aa, ab, ac, ... the department had apparently never got past 26 projects.

I wonder why?

Comments

RabidHamster said…
I'd say there are worse variable names... $data is rampant, for example.

And then there's variable names where you can't tell if it's "l" (lover case ell) or "1" (one).

if $counter_l == $counter_1:
do_something()

Or, even better, $shititsmidnightlouise .


--

The Banjo Players Must Die
Tyson said…
Or, just as fun, the ubiquitous "tmp" variable that always somehow becomes part of production code.
Christian Knott said…
Hey I was offered that job! Turned it down 'cos I wanted to work on the wicked cool (then) Windows 3.1.

Nearly 2 decades of hell later ...
Peter said…
And then there's variable names where you can't tell if it's "l" (lover case ell) or "1" (one).

To be fair, that's at least as much your fault for coding with a font that makes that ambiguous. There are good, fixed-width fonts that handle potentially ambiguous characters well. I like monaco myself.

Popular posts from this blog

How to write a successful blog post

First, a quick clarification of 'successful'. In this instance, I mean a blog post that receives a large number of page views. For my, little blog the most successful post ever got almost 57,000 page views. Not a lot by some other standards, but I was pretty happy about it. Looking at the top 10 blog posts (by page views) on my site, I've tried to distill some wisdom about what made them successful. Your blog posting mileage may vary. 1. Avoid using the passive voice The Microsoft Word grammar checker has probably been telling you this for years, but the passive voice excludes the people involved in your blog post. And that includes you, the author, and the reader. By using personal pronouns like I, you and we, you will include the reader in your blog post. When I first started this blog I avoid using "I" because I thought I was being narcissistic. But we all like to read about other people, people help anchor a story in reality. Without people your bl

Your last name contains invalid characters

My last name is "Graham-Cumming". But here's a typical form response when I enter it: Does the web site have any idea how rude it is to claim that my last name contains invalid characters? Clearly not. What they actually meant is: our web site will not accept that hyphen in your last name. But do they say that? No, of course not. They decide to shove in my face the claim that there's something wrong with my name. There's nothing wrong with my name, just as there's nothing wrong with someone whose first name is Jean-Marie, or someone whose last name is O'Reilly. What is wrong is that way this is being handled. If the system can't cope with non-letters and spaces it needs to say that. How about the following error message: Our system is unable to process last names that contain non-letters, please replace them with spaces. Don't blame me for having a last name that your system doesn't like, whose fault is that? Saying "Your

The Elevator Button Problem

User interface design is hard. It's hard because people perceive apparently simple things very differently. For example, take a look at this interface to an elevator: From flickr Now imagine the following situation. You are on the third floor of this building and you wish to go to the tenth. The elevator is on the fifth floor and there's an indicator that tells you where it is. Which button do you press? Most people probably say: "press up" since they want to go up. Not long ago I watched someone do the opposite and questioned them about their behavior. They said: "well the elevator is on the fifth floor and I am on the third, so I want it to come down to me". Much can be learnt about the design of user interfaces by considering this, apparently, simple interface. If you think about the elevator button problem you'll find that something so simple has hidden depths. How do people learn about elevator calling? What's the right amount of