We need to make some changes. We need to be clear on why
TL;DR: Be declarative on your design or implementation decisions.
-
Code Comments
-
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 can't write a failing test, we need to have a function with an excellent and declarative name instead of a comment.
// You need to run this process with more memory
set_memory("512k");
run_process();increase_memory_to_avoid_false_positives();
run_process();[X] Semi-Automatic
This is a semantic smell.
They can detect comments and warn you.
- Declarative Code
Code is prose. And design decisions should be narrative.
Code Smell 05 - Comment Abusers
Code Smell 75 - Comments Inside a Method
Code Smells are just my opinion.
Photo by Goh Rhy Yan on Unsplash
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.
Mario Fusco
Software Engineering Great Quotes
This article is part of the CodeSmell Series.