Comments Are More Important Than Code
Wednesday, April 27th, 2005I noticed this essay by Jef Raskin mentioned on slashdot the other day, arguing for better documentation, as opposed to relying on “self documenting” code and the like. My favorite line from the essay:
That we use escape characters to “escape” from code to comment is backwards. Ideally, comment should be the default, with a way to signal the occasional lines of code.
How well put! Documentation should be used not just to prevent confusion among future maintainers (who often include the author), but to help the writer define and think about the peice of code they are writing.
I’m filing this under news “Clippings”, so I’ll stop here, but what good stuff!