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

1. Use intention revealing names.

2. 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....

Tags

• Readability

Conclusion

Always use intention revealing names.

If your names collide use local names, extract your methods and avoid 'the' prefixes.

Relations

Code Smell 38 - Abstract Names

Maxi Contieri ・ Nov 30 '20

#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

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