I agree, that under ideal situations, code self documents. However, some of the best code bases I've seen are sprinkled with comments — lots of them. I like stating the pre and post conditions of my functions. Also, I like explaining the reasoning behind the module I'm building as well. Not only what it does, but what it doesn't do as well.
I agree, that under ideal situations, code self documents. However, some of the best code bases I've seen are sprinkled with comments — lots of them. I like stating the
preandpost conditionsof my functions. Also, I like explaining the reasoning behind the module I'm building as well. Not only what it does, but what it doesn't do as well.Cheers,
Matt Chung
@memattchung