Comments on: When Commented-Out Code Is Acceptable

By: Alexander Byndyu

Alexander Byndyu — Fri, 17 Oct 2008 07:52:51 +0000

Sorry for using < in previous comment =)

I like to use XML comment for “example” and “exception” public properties/function information.

By: Alexander Byndyu

Alexander Byndyu — Fri, 17 Oct 2008 07:51:28 +0000

I like to use XML comment for and public properties/function information.

By: Davy Brion

Davy Brion — Wed, 15 Oct 2008 05:00:46 +0000

nice! didn’t know about that one

By: Brian Genisio

Brian Genisio — Tue, 14 Oct 2008 23:03:06 +0000

For your second case, Nunit has an attribute called “Explicit”. It is kind of like “Ignore” but not as strong… you can still click on the test and run it… explicitly. It just doesn’t get run automatically.

What do you think of that approach?

By: Arjan`s World » LINKBLOG for September 22, 2008

Arjan`s World » LINKBLOG for September 22, 2008 — Mon, 22 Sep 2008 20:32:21 +0000

[...] Commented-Out Code and Broken Windows – Jan van Ryswyk ‘ To me, a piece of code that contains commented-out lines is just another piece of crap ‘ I always feel like Ive done civilization a service when I remove old commented-out code from version-controlled source, so agreed here. Davy, on the other hand, has some situations where he leaves it, though [...]

By: Jan Van Ryswyck

Jan Van Ryswyck — Mon, 22 Sep 2008 07:13:44 +0000

Code can be part of the documentation. To me, this is a different thing. Putting a piece of code in the documentation explaining why it doesn’t perform well is something you do because you care. You, as the code writer, want the code to make sense for the next guy.

The commented-out code that I was refering to is just the opposite of care, namely ignorance. This is the worst enemy of any software system.

Nice follow-up B.T.W. .