When Coding

[russellr]

Do you like to comment or label everything your work as your going? Or do you rarely label at all?

---

I've just noticed that I seem to comment also every other line which is a bit to much don't you think? Then again I am very forgetful and if I don't I'll never get anything done!

[Cam]

I sometimes comments things if it's hard to understand like my current project.

[Nightwalker]

I hardly comment unless the code is a bunch of different codes put together.

[moneyman18]

The only time I would ever comment is if someone else will be using or editing the code or if someone asked me to comment it otherwise I think they are for the most part a waste of time.

[edenwax]

I usually comment things to keep things nice and organized. In my css, I usually sort it out by id's, classes, headers, main content, and footers.

[Nick]

Eh. I am usually so excited about the code, I only comment the things that I know I'll forget I usually come back like a day after and comment everything.

[Cam]

Nov 20, 2010 23:54:32 GMT Nick said:

Eh. I am usually so excited about the code, I only comment the things that I know I'll forget I usually come back like a day after and comment everything.

That's a interesting way

[John Wankel]

I only comment if someone is going to be using it.

[Nick]

Nov 21, 2010 3:54:31 GMT John Wankel said:

I only comment if someone is going to be using it.

Yeah. It is so easy to take your own style of coding for granted.

[Cam]

Nov 21, 2010 3:54:31 GMT John Wankel said:

I only comment if someone is going to be using it.

Yeah I do that with my proboards codes like the one I'm making now.

[prads]

Commenting your code is a good habit but over-commenting is not so good. But I have a stupid habit to over-comment my code. LOL
I also make separate documentation so that other programmers can understand my mess, haha

[russellr]

Is it possible to over-comment?

[Nick]

Nov 22, 2010 12:11:11 GMT russellr said:

Is it possible to over-comment?

Trust me, there is

I like outsourcing my comments into documentation because it is so much neater.

[prads]

Nov 22, 2010 12:11:11 GMT russellr said:

Is it possible to over-comment?

counter++;    //Incrementing the counter

I tend to do that a lot. ;D

[Cam]

I over comment sometime xD

[Bobby]

I probably err on the side of over commenting. I'm not verbose to the point where I comment the blatantly obvious. But I do like to have plain text descriptions of what is going on (or should be going on) throughout my code. It helps in debugging as I essentially write out my logic flow in comments, so it's right there. It also make re-acclimating to the source, should I abandon it for a few weeks, much easier.

I say I err on the side of over commenting because besides the inline comments throughout my methods, I always lead a method off with a comment block. In that comment block I specifically outline what the method does and how it does it. I also document parameters, return values, any exception throwing, whether or not the method is static and also the visibility of the method. These comment blocks are more for the likes of Doxygen, RDoc, phpDoc, etc. though.