RobEasy

I am still learning to code, so I use comments to go back and see how I used my code. That is the important thing to do for me. Although a simple design with explicit code does allow for transparency, I would still like to comment, especially if I come up with a large program.

Harakim

Also, I think commenting helps you write better code which ironically mitigates the need for comments.

DaWei

If commenting helps you write better code, then you didn't design your code first, which you should. Whether or not better code mitigates the need for comments is strictly circumstantial. Someone could write you some absolutely beautiful, efficient, and functional code. If you didn't know what was going on (encryption or nuclear physics, anyone?) you couldn't decipher it without an explanation.

__________________
Abstraction doesn't make it impossible to write bad code; it makes it possible to write superior code.
Contributor's Corner: Grumpy on C++ Exceptions DaWei on Pointers

Adak

Had a couple experiences with "This can't be my code - it doesn't LOOK like my code! It doesn't even look like it was written by a HUMAN, at all!!".

I strive for more clarity in my programs, and definitely more comments, and more informative comments. Every non-trivial line of code will have something for a comment.

Adak

Mad_guy

I comment things like my Data structures fairly well and my functions, inside a function I don't document as much myself.

__________________
os: mac os 10.5.4
revision control: git
editor: emacs

site

chepfaust

line by line is a little excessive, but i'm with you in spirit.

perhaps it's a total noob thing to do, but i always start my programs by using comments to write out, in plain english, every step of everything i want my finished product to do. this is the extent of my commenting.

then i go and create my code in between the comments.

it not only helps when i need to go back and look at something i wrote six months ago, but while i'm in the process of coding it helps me maintain focus on what i need to accomplish.

Mocker

I dont' comment and I write a lot of confusing code. This way, I can open the same program a little later, and its like a whole new puzzle trying to figure it out, instead of boring "yea it does this" type code.

__________________
#programmingforums relay - http://thegupstudio.com/cgi-bin/pforelay.cgi
freelance scripts - http://ryanguthrie.com/index.html

rsnd

hmmmm...I start coding with comments

__________________
Spread your wings and fly! Chicken!

Griz803

I usually find that if I stick to three rules, it works pretty well. They are:
/*1) If it isn't clear enough to me at the time of the writing to explain in 3 line comments, I'd better look around some more because I'm being DUMB!
2) Make sure that all your variables, structures, classes and functions are explanatory in their own names and code.
3) Switch rule 1's and 2's priority and check it again, document anything that doesn't look right and let some one else read it to see if they understand it.
If I get by those the first time, a miracle has occurred ;-)*/

King

Line by line might be a little much. Maybe you should have a comment about what the function or chunk of code does, then let the code explain itself. And if for some reason a certain line of code isn't obvious of what you’re trying to do, then add another comment in.

__________________
I am Addicted to Linux!