I'm James Hague, a recovering programmer who has been designing video games since the 1980s. This is Why You Spent All that Time Learning to Program and The Pure Tech Side is the Dark Side are good places to start.
Where are the comments?
Don't Structure Data All The Way Down
Let's write some functions to operate on circles, where a circle is a defined by a 2D center point and a radius. In Erlang we've got some options for how to represent a circle:
Hmmm...why is a circle represented as a structure, but a point is unwrapped, so to speak, into two values? Attempt #2:
Now let's write a function to compute the area of a circle, using this new representation:
Simple enough. But take a few steps back and look this. First, we're not actually making use of the structure of the data in
area. We're just destructuring it to get the radius. And to do that destructuring, there's a bunch of code generated for this function: to verify the parameter is a tuple of size 3, to verify that the first element is the atom
circle, to verify the second element is a tuple of size 3 with the atom
point as the first element, and to extract the radius. Then there's a trivial bit of math and we've got an answer.
Now suppose we want to find the area of a circle of radius 17.4. We've got a nice function all set to go...sort of. We need the radius to be part of a circle, so we could try this:
Kind of messy. What about a function to build a circle for us? Then we could do this:
We could also have a shorter version of
make_circle that only takes a radius, defaulting the center point to 0,0. Okay, stop, we're engineering ourselves to death. All we need is a simple function to compute the area of a circle:
Resist the urge to wrap it into an abstract data type or an object. Keep it raw and unstructured and simple. If you want structure, add it one layer up, don't make it part of the foundation. In fact, I'd go so far as to say that if you pass a record-like data structure to a function and any of the elements in that structure aren't being used, then you should be operating on a simpler set of values and not a data structure. Keep the data flow obvious.