Code Craft

In a Nutshell

Major writing is to say what has been seen, so that it need never be said again.

—Delmore Schwartz

We write a lot of comments. That’s because we write a lot of code. Learning to write the right sort of comment is important, or our code may keel over under the weight of inappropriate and outdated commenting.

Comments are no more important than the code they annotate—you can’t make bad code good using comments. Your aim should be self-documenting code that requires no comments at all.

Good programmers . . .	Bad programmers . . .
Try to write a few really good comments Write comments explaining why Concentrate on writing good code rather than a plethora of comments Write helpful comments that make sense	Can’t tell the difference between ...