quote:

---

You know, after finishing and documenting a program I wrote for the company I work for, and having my buddy and coworker shake his head at the detail I put into it, I started to wonder: How well do you comment?

Me, I learned the hard way. I've always had the habit of starting a project, dropping it and coming back to it a few days or weeks later (sometime after starting yet another doomed project - a habit I'm desperatly trying to break). However, when i got back to my old program, I'd open it up, take one look at a function and say to myself: "What the $#*! does THIS do?"

So ever since I've gotten into the habit of commenting just about every single line of code. It's taken me a while, but I've finally settled on a method that doesn't clutter up the screen and mix up comment and code so much it becomes unreadable - a bad twist to a good thing. I even go so far as to point out what the parameters or arguments do in a function, as well as explain the nature of the function in detail. What this has led to is the ability to put a project aside, come back to it later and just read through the code and relearn all that I had done with it and start off right where i left off, a wonderful thing.

So if any of you newbies haven't gotten into the habit of commenting, or you experienced people as well, do it. i don't care if you think you have a good memory, or that it takes too much time, or that it makes your .exe larger (not true, since all comments and white-space are taken out during compiling). The plain fact is that commenting HELPS whether you like it or not, and I can garuntee it'll get you on the good side of any game developer looking to hire you. (although when my computer science teacher tried to hug me for my wonderful commenting, I was a bit scared... don't worry, it was a woman)

==============================
\\// live long and prosper; \||/ die short and rot.
==============================

---

sharewaregames.20m.com

quote:

---

Original post by Gorky

Have fun with the comments if you can.
Some of my co-workers don't appreciate humour in comments, but some do. I think it helps lighten the moode of the viewer.

No: delete(b_ticketingMod) // Delete the ticketing mod item

Yes: delete(b_ticketingMod) // Toast the puppy!

Of course, only do this on lines that are fairly obvious.

---

#include  // include windows header file
#include  // include standard i/o header file
 

if (x==0) // test if x is equal to zero
{
 x=5; // make x equal to 5
} // end the "if x is equal to zero" statement