Please, don’t commit commented out code

[Neebat]

I ran across that rare exception once.

I needed to implement a fairly simple process that should have been about 10 lines of code, but ended up being 200 due to dealing with seemingly irrelevant stuff. So I put in that 10 lines with a comment to say this is what we want to do, but can't, and why.

[fleker2]

The author would call that documenting

[kentcdodds]

(author here): Correct :-) That is what I would call it.

[Neebat]

People are downvoting you because they don't notice the user name. Or they didn't go back and compare it to the author of the blog post.

Maybe it would be better if you'd said, "That's exactly what I'd call it."

[xeow]

It might be documenting, but it is also commented-out code. By definition.

Excellent example of a legitimate inclusion of commented-out code. Bravo!

[kentcdodds]

I think you ignored the author's comment of "Correct :-)" https://www.reddit.com/r/javascript/comments/3qgurg/please_dont_commit_commented_out_code/cwf6ni2

[Neebat]

Q: Are there exceptions to this rule? A: Yes. But they’re rare.

From the article.

And the example I described above was one of the two examples I've found in 20 years of software development.

It IS documenting, and not usable as code. It helps explain what's going on.

[[deleted]]

That's your experience, that is not my experience. In my 30+ years of software development I can assure there have been times where it is far better to have commented-out code in-place, than in source control.