Comments on: How Not to Comment Your Game Code

By: Alfred R. Baudisch

Alfred R. Baudisch — Mon, 20 Oct 2008 14:06:05 +0000

“I don’t write much comments. My goal is that the code speaks for it self. But it is funny to find 3-4 year old code sometimes and with no comments. It takes a few minutes (hours) to figure stuff out :)”

But THAT is the point. You can spend 5-15 minutes writing comments while coding, and saving hours/days later (depending on amount of code).

By: Alfred R. Baudisch

Alfred R. Baudisch — Mon, 20 Oct 2008 14:04:19 +0000

I love to comment. For each function/class/important lock, after I finish, I write a long and descriptive documentation in JavaDoc syntax.

I can still use 10 years old code without even bothering “what the heck does this do, I cant remember”.

By: desertdweller

desertdweller — Thu, 25 Sep 2008 20:46:09 +0000

Exactly. Every once in a while, I dare to look back at some of my code, and I’m horrified that I have no idea what some parts are there for.

By: Toni Mäkinen

Toni Mäkinen — Thu, 25 Sep 2008 11:37:52 +0000

I don’t write much comments. My goal is that the code speaks for it self. But it is funny to find 3-4 year old code sometimes and with no comments. It takes a few minutes (hours) to figure stuff out :)

By: Jake Birkett

Jake Birkett — Thu, 25 Sep 2008 08:37:03 +0000

Luckily because I sell my framework I feel I have to make good comments because other people will be reading them, so it’s like having someone look over my shoulder.

By: Juuso Hietalahti

Juuso Hietalahti — Thu, 25 Sep 2008 06:41:51 +0000

sean, I do agree. one should seek to avoid comments… and rather name methods/functions/variables/etc. in such way that the ‘logic reveals’ itself.

sometimes it might be a good idea to provide little insight why/how certain stuff happens…

By: sean

sean — Wed, 24 Sep 2008 20:53:43 +0000

comments in code are _almost_ universally bad. properly written code comments itself!

By: Juuso Hietalahti

Juuso Hietalahti — Wed, 24 Sep 2008 15:00:18 +0000

Heh, have you tried checking out your code after 6 months? Or 12 months? :)

By: Eli

Eli — Wed, 24 Sep 2008 14:49:38 +0000

I swear; I write the most horrid comments in the whole world. The only plus; is that I can continue to understand them. Watch out; however, if you be the unfortunate person who has to read or work with my code. I am working on it though. So.. yes, onward and upward.