#naming #clean-code #lint #semantics

idea

When naming things, don't be cute. It is tempting to call things with a funny name or acronym, but using a plain, meaningful name is more helpful for everyone: people external to context, or yourself in the future.

links

• Meaningful names builds Clean code

references

• Bob Martin / Clean Code

  “Don’t Be Cute

  If names are too clever, they will be memorable only to people who share the author’s sense of humor, and only as long as these people remember the joke. Will they know what the function named HolyHandGrenade is supposed to do? Sure, it’s cute, but maybe in this case DeleteItems might be a better name. Choose clarity over entertainment value. Cuteness in code often appears in the form of colloquialisms or slang. For example, don’t use the name whack() to mean kill(). Don’t tell little culture-dependent jokes like eatMyShorts() to mean abort().

  Say what you mean. Mean what you say.”

  Excerpt From: Martin, Robert C. “Clean Code: A Handbook of Agile Software Craftsmanship.”