Comments in code that I have to edit, particularly comments at the beginning of a function or class, have exactly one purpose: convincing me that this code is important enough that I shouldn’t delete it. Tell me what the class does, tell me what the function does, and do it all in convincing enough language that I won’t try to delete your code. Code is hard to write, but it’s even harder to read. So when I am reading it I constantly want to delete it so that I will never have to read it again. All of your code should be essential to the task at hand. If it is not essential, it should be removed. Comments exist to argue for a chunk of code’s life.
-
http://twitter.com/clipdude Chris
-
http://home.manhattan.edu/~peter.boothe/ Peter Boothe
-
http://twitter.com/clipdude Chris









