Names should be long and descriptive. How Long?

TL;DR: Names should be long enough. No longer.

Problems

• Readability

• Cognitive Load

Solutions

1. Use names related to the MAPPER

Context

We used very short names during the 50s and 60s due to space and time constraints.

This is no longer the case in modern languages.

Sometimes we get too excited.

Naming is an art and we should be cautious with it.

Sample Code

Wrong

PlanetarySystem.PlanetarySystemCentralStarCatalogEntry

// Redundant

Right

PlanetarySystem.CentralStarCatalogEntry

Detection

[X] Semi-Automatic

Our linters can warn us with too long names.

Tags

• Bloaters

• Naming

Conclusion

There are no hard rules on name length.

Just Heuristics.

Relations

Code Smell 33 - Abbreviations

Maxi Contieri ・ Nov 24 '20

#oop #codenewbie #programming #tutorial

More Info

• What exactly is a name? — Part I: The Quest

• What exactly is a name? — Part II: Rehab

• Long and Short of Naming

Credits

Photo by Emre Karataş on Unsplash

Many people tend to look at programming styles and languages like religions: if you belong to one, you cannot belong to others. But this analogy is another fallacy.

Niklaus Wirth

Software Engineering Great Quotes

Maxi Contieri ・ Dec 28 '20

#codenewbie #programming #quotes #software

This article is part of the CodeSmell Series.

How to Find the Stinky parts of your Code

Maxi Contieri ・ May 21 '21

#codenewbie #tutorial #codequality #beginners