> A good rule of thumb is: If a name requires a comment, then it doesn’t reveal the intent.
This can actually be extended to whole functions as well. doProcessMessage() is terrible but sendMailIfNewAccount() is an improvement.
We have a rule that we don't write comments, instead we write log messages, and we try to write them after every branch corresponds with a business decision.
2 comments
[ 4.3 ms ] story [ 16.3 ms ] threadThis can actually be extended to whole functions as well. doProcessMessage() is terrible but sendMailIfNewAccount() is an improvement.
We have a rule that we don't write comments, instead we write log messages, and we try to write them after every branch corresponds with a business decision.