← Field notes koodalanne

Field note 02

Naming things after road signs

If it needs a legend, it's the wrong name.

Rider beside a trail signpost.

Cycling has an impressive number of signs that don't need explaining.

Stop.

Yield.

Turn left.

You don't need a meeting to discuss what "STOP" means.

Software names should ideally work the same way.

Sometimes you open a codebase and encounter something like:

processDataHandlerManagerService

Which sounds important.

It probably does something important.

Nobody knows what.

Good names don't need a legend.

They tell you enough about what you're looking at without making you open three files and summon the original author.

This doesn't mean every variable needs to become a sentence.

Sometimes events is better than dailyEventsThatShouldBeIncludedInTheCurrentCalculation.

The goal is simply to make the next person think:

"Ah. I know what this is."

Then keep moving.

Like a road sign.