Removing Comments

I had an interesting task at work today. I maintain a project that has gone through at least 5 other developers before myself. When I was hired, it was to lighten the workload of the current-at-the-time developer. This developer had a bit of a personality problem, and she didn't get along with the rest of the team as a result. She was eventually fired, and I was left as the lead maintainer of the application, making changes as needed and improving it.

I've done a great deal of work on it, but it could only be improved so much, as the system has over 50 dependencies on unstable legacy systems out of our control. It's a real hassle to maintain. Well, the day has finally come where I can stop working with this nightmarish project. At the end of the month, the project is being officially sunset permanently. I'll be bringing a bottle of wine to work.

Unfortunately, one condition of the sunset is that the company we built it originally for gets to buy the source code. This isn't a problem, except that this previous developer generously spread helpful comments all around the system. She spent most of her time on the project simply keeping it running rather than actually improving the code, so most of her comments were along the lines of "this piece of code should be improved!" She never actually improved the code herself, but I'm sure she felt better making it known that she cast derision upon the other 3 developers before her.

My task today was to "clean up" the code so that this other company can buy it from us.

Keep in mind, this project is, and always was, a large-scale enterprise application built for a professional company. Here are a handful of her comments, which I removed:

  • //what the ??
  • //oughta throw a stinking exception!!
  • //really cool that the history entries are in reverse order
  • //should i do something here?
  • //need to catch something better than a plain old exception
  • //stupid but add 4
  • //think we need some error checking here
  • //why are we converting this?
  • //rewrite this bastard
  • //I know I'm writing icky code.
  • //not sure why but something was not quite right
  • //still figuring out the static block
  • //what the hell is this?
  • //clean up some of the formatting problems that {Company X} is complaining about.

That last one is my favorite, because {Company X} is the company that is buying this source code from us.

The best part about this whole thing is that the salesguy in charge of sunsetting this project decided to sell the code to Company X for $1. I guess he imagined that, since the code is already done, it's a free buck.

Of course, I spent 2 hours combing through all of the comments in the code to remove all of this stuff (and more), so overall the company lost a significant amount of money on this "sale".

I find the fact that the sale was for a single dollar symbolic. Of what, I'm not sure.

Unleash This Post Upon Others:These icons link to social bookmarking sites where readers can share and discover new web pages.
  • del.icio.us
  • digg
  • Fark
  • YahooMyWeb
  • NewsVine
  • Ma.gnolia
  • blogmarks
  • co.mments
  • connotea
  • De.lirio.us
  • Furl
  • Netvouz
  • RawSugar
  • Reddit
  • scuttle
  • Shadows
  • Simpy
  • Smarking
  • Spurl
  • TailRank

2 Comments

  1. off:

    Sure but imagine how it feels when you write yourself something like “// Empirically obtained delay constant”, or (my favourite) “// Yes. That’s it. I was inspired by the Devil!”

  2. Maki:

    haha this is so funny. I imagine that chic who worked before you looked like while she wrote those comments. Somehow a transparent from Bugs Bunny cartoons saying “sand in vagina?” comes in mind.

Leave a comment