result = ???

TL;DR: Use good names always. Result is always a very bad name.

Problems

• Readability

Solutions

1. Rename result.
2. If you don't know how to name it, just name the variable with the same name as the last function call.
3. Don't use IDEs without automatic refactors.

Refactorings

Refactoring 006 - Rename Result Variables

Sample Code

Wrong

var result;

result = lastBlockchainBlock();
//

// Many function calls

addBlockAfter(result);

Right

var lastBlockchainBlock;

lastBlockchainBlock = findlastBlockchainBlock();
// ...

// Many function calls 
// we should refactor them to minimize space
// between variable definition and usage

addBlockAfter(lastBlockchainBlock);

Detection

We must forbid the word result to be a variable name.

Tags

• Readability

Conclusion

Result is an example of generic and meaningless names.

Refactoring is cheap and safe.

Always leave the campground cleaner than you found it.

When you find a mess on the ground, clean it, doesn’t matter who did it. Your job is to always leave the ground cleaner for the next campers.

Relations

Code Smell 79 - TheResult

More Info

• What is in a name? Part I: Rehab.

Credits

Photo by KMA on Unsplash

Code is like humor. When you have to explain it, it’s bad.

Cory House

Software Engineering Great Quotes

This article is part of the CodeSmell Series.

How to Find the Stinky Parts of your Code