We need to make some changes. We need to be clear on why
TL;DR: Be declarative on your design or implementation decisions.
Lack of testability
Be Explicit about the reasons.
Convert the comment to a method.
Sometimes we find arbitrary rules not so easily testable.
If we cannot write a failing test, we need to have a function with an excellent and declarative name instead of a comment.
// We need to run this process with more memory set_memory("512k) run_process();
This is a semantic smell.
We can detect comments and warn us.
Code is prose. And design decisions should be narrative.
Code Smells are just my opinion.
Programs, like people, get old. We can’t prevent aging, but we can understand its causes, limit its effects and reverse some of the damage.
This article is part of the CodeSmell Series.