Survey Results

6 months? Sometimes last week is more like it!

I have to say that I do not ever comment code to say what it does. It should be obvious, as the saying goes 'it does what it says on the tin!'. If it is not obvious then either the method is to long, or the method is badly named.
Hoever, I always comment what I was thinking at the time. At least then I know why I wrote this rubbish, and it is usually only rubbish if the reasoning/understanding of the problem was wrong, or the problem changes.

If you have knowledge, let others light their candles at it.
Margaret Fuller (1810 - 1850)
[My Articles] [My Website]

Dalek Dave wrote:
Also, why is it possible to select "I don't Comment" and any other comment selection? Mutual Exclusivity!

I won't comment on that.

home

But, in fact, you still can.

Ninja (the Nerd)

Confused? You will be...

I was in middle of code handover at client premises, and the IT personnel was like: "I cannot see any comments in your code WTF | :WTF:

"

Then we did. Laugh | :laugh:

Noman Muhammad Aftab,
Software Mechanic

It's going to be interesting to see the result...

modified on Monday, July 19, 2010 4:43 AM

yes a good question.

Very well asked, I agree.

Agh! Reality! My Archnemesis![^]

| FoldWithUs! | sighist | µLaunch - program launcher for server core and hyper-v server.

Of course good question. But 10 12 21 27 people voted for "I do not comment code." D'Oh! | :doh:

thatraja

Tips/Tricks|Brainbench certifications|Facebook|Twitter

modified on Tuesday, July 20, 2010 9:49 AM

Option	Votes	%
I add comment headers for all public classes, objects and methods, events, fields etc	362	44.15
I add comment headers for all non-public classes, objects and methods, as well as non-obvious logic inside these	246	30.00
I provide comments at the top of files	178	21.71
I comment any code that may be obscure (the "what") to a reader	511	62.32
I comment any code where the purpose (the "why") may be obscure	544	66.34
I comment on expected inputs, outputs and other results	176	21.46
I comment on exceptions, side effects or error codes	205	25.00
I comment on structures (loop endings, function endings etc)	107	13.05
I comment as a last resort when I can't make my code any clearer	222	27.07
I do not comment code.	46	5.61
Responses	820
Respondents were allowed to choose more than one answer; totals may not add up to 100%

Do you comment your code? [Edit]