Don’t let your comments ramble on about the past or future.
Tag Archives: comments
Don’t use comments as version control.
Instead, use version control software, like git.
Avoid comments at the end of a code block.
Your block is probably too big.
Comments cannot enforce types or usage.
Use code for this.
Don’t repeat code logic in the comments.
Logic should appear in only one place.
Make the robots talk.
Your unit tests should convey more information.
Go to the source.
The code tells the true story.
Add comments to explain ideas.
Some things are not obvious from self-documenting code.
Kent Beck’s Rules of Simple Design, #2
The code must express the intent of the programmers.
Look out for comments at the end of a block.
They may seem helpful, but they’re also a bad sign.
