My Home About Me

When reading a programming book, it can be tempting to skim the code examples. But they likely have some nuggets that are worth learning. The problem is that we don't like to read code written by other people - or at least it doesn't come naturally to us. What we need is a technique for rapid understanding of new code.

I propose reading the code aloud. Now, to make sure we don't get distracted by syntactic details, we can probably come up with some rules for what to omit. Consider this example from Martin's Agile Software Development:

  ifndef GEOMETRY_RAY_H
  define GEOMETRY_RAY_H

  class Ray : public LinearObject
  {
    public:
      Ray(const Point& p1, const Point& p2);
      virtual bool IsOn(const Point&) const;
  };
  endif

I would read this aloud as follows:

class Ray, extends LinearObject
Ray p1, p2
IsOn Point, returns bool

So we have a first cut at a rule of thumb for things to skip:

• start and end matter (e.g. ifndef, define, endif)
  
• access modifiers (public, protected, private)
• parameter types

We also see a couple of transliterations (text transformations):

• in C++, read ":" as "extends"
• in function declarations, read "[type] ..." as "... returns [type]"

A more enterprising reader of code could expand or revise these rules and we could have, say, 10 tips for reading code aloud, for maximum comprehension.

Amateur Investors   assets   bailout   bottom   capitulation   climactic   Commodity ETFs   credit crunch   Currency ETFs   day trading   Deron Wagner   DJIA chart   Dow 1929 Crash   economic data   Emini's Nas 100   emini's S&P 500   emini's S&P 500e   ETFs (exchange trade funds)   ETFs (exchange traded funds)   Exchange Traded Funds (ETFs)