Code Smell 79 - TheResult

Code Smell 79 - TheResult

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

Maxi Contieri
·Jun 14, 2021·

1 min read

Subscribe to my newsletter and never miss my upcoming articles

Play this article

Table of contents

  • Problems
  • Solutions
  • Refactorings
  • Sample Code
  • Detection
  • Tags
  • Conclusion
  • Relations
  • More info
  • Credits

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

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.

 
Share this