Comments on: Comenting out code http://hardlikesoftware.com/weblog/2007/11/28/comenting-out-code/ The writings of John Snyders, mostly about software. Thu, 20 Nov 2008 20:43:37 +0000 http://wordpress.org/?v=2.1.3 By: David http://hardlikesoftware.com/weblog/2007/11/28/comenting-out-code/#comment-3329 David Thu, 29 Nov 2007 19:33:02 +0000 http://hardlikesoftware.com/weblog/2007/11/28/comenting-out-code/#comment-3329 I couldn't agree more. I also find this widespread practice extremely irritating. Even in the case of "uncomment this code once the foo module is available" I would prefer to use an "ifdef" if possible or at least "TODO: Uncomment this code..." because I will search for those and some IDEs will list them. Another practice I don't like is people commenting with the name or initials and date of a change: // jsmith -- 12/1/2003 The source control system will keep track of that information. Over time, code gets filled with this superfluous meta data. I couldn’t agree more. I also find this widespread practice extremely irritating. Even in the case of “uncomment this code once the foo module is available” I would prefer to use an “ifdef” if possible or at least “TODO: Uncomment this code…” because I will search for those and some IDEs will list them.

Another practice I don’t like is people commenting with the name or initials and date of a change:
// jsmith — 12/1/2003
The source control system will keep track of that information. Over time, code gets filled with this superfluous meta data.

]]>