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

    19

    This website collects cookies to deliver better user experience

    Code Smell 79 - TheResult