TL;DR: don't prefix your variables.

Problems

• Readability

• Meaningless names

Solutions

1. Use intention revealing names.

2. Avoid Indistinct noise words.

Refactorings

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

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

---

This article is part of the CodeSmell Series.