Tidy First?

Chapter 8. Explaining Variables

Some expressions grow. Even if they start small, they grow. And they grow and they grow. And then along you come with your reading glasses on, and you try to understand what’s happening.

When you understand a part of a big, hairy expression, extract the subexpression into a variable named after the intention of the expression.

You’ll see this frequently in graphics code:

return new Point(
    ...big long expression...,
    ...another big long expression...
)

Before changing one of those expressions, consider tidying first:

x := ...big long expression...
y := ...another big long expression...
return new Point(x, y)

Or maybe the expressions mean something more specific, like width and height, top and left, run and rise.

In this tidying you are taking your hard-won understanding and putting it back into the code. This sets you up to change either one of those expressions more easily (because now they are separated), and to read them more quickly next time the code needs to change.

As always, separate the tidying commit from the behavior change commit.