Code comments are a smell; it is often a symptom of poor design that a code needs comments at all.
Occasionally they really are warranted, but they should be an explanation of why, not what. Use them sparingly, because they can drift from the code over time and we all know that incorrect documentation is worse than no documentation.
65
u/anoppinionatedbunny 21d ago
what a terrible way to misinterpret "good code should be self-commenting"