Code Smell 79 - TheResult

If a name is already used, we can always prefix it with 'the'.

TL;DR: don't prefix your variables.

Problems

Readability

Meaningless names

Solutions

Use intention revealing names.

Avoid Indistinct noise words.

Sample Code

Wrong

var result;

result = getSomeResult();

var theResult;

theResult = getSomeResult();

Right

var averageSalary;

averageSalary = calculateAverageSalary();

//..

var averageSalaryWithRaises;

averageSalaryWithRaises = calculateAverageSalary();

Detection

As with many of our naming conventions, we can instruct our linters to forbid names like theXxx....

Code Smell 38 - Abstract Names

Maxi Contieri ・ Nov 30 '20 ・ 1 min read

#oop #codenewbie #naming #webdev

More info

What is in a name.

How To Be Great At Giving Meaningful Names.

Credits

Photo by Josue Michel on Unsplash

One difference between a smart programmer and a professional programmer is that the professional understands that clarity is king. Professionals use their powers for good and write code that others can understand.

Robert C. Martin