Stop Commenting Your Code
antonpug.com
Stop Commenting Your Code
1–10 of 18 posts
Re: Stop Commenting Your Code
#2No.
Re: Stop Commenting Your Code
#3No.
Could you be a little bit more constructive? It's okay if you disagree - but I'd be curious to hear your side.
Re: Stop Commenting Your Code
#4> Heavy code commenting is a symptom of bad code.
I used to believe that comments were unnecessary for good code but eventually found this to be false.
Now I do code annotation where every single line of code is commented.
This allows the entire program to be read as plain english which is much faster and less mentally taxing than trying to read code.
Re: Stop Commenting Your Code
#5> Heavy code commenting is a symptom of bad code. I used to believe that comments were unnecessary for good code but eventually found this to be false. Now I do code annotation where every single line of code is commented. This allows the entire program to be read as plain english which is much faster and less mentally taxing than trying to read code.
Sarcasm? Or am I misunderstanding your comment? :) You annotate "every line"?
Re: Stop Commenting Your Code
#6> Heavy code commenting is a symptom of bad code. I used to believe that comments were unnecessary for good code but eventually found this to be false. Now I do code annotation where every single line of code is commented. This allows the entire program to be read as plain english which is much faster and less mentally taxing than trying to read code.
Sarcasm? Or am I misunderstanding your comment? :) You annotate "every line"?
In most cases yes. I make sure the comments provide a complete plain language description of the program.
Reading english (or whatever your native language is) is much much faster than parsing code.
Re: Stop Commenting Your Code
#7Re: Stop Commenting Your Code
#8No.
Could you be a little bit more constructive? It's okay if you disagree - but I'd be curious to hear your side.
I like your article and the example you used, code clarity is vital. Poor code is often accompanied by many poor comments which only helps in overwhelming the next poor soul who has to read the code.
However, I think that the larger the project, the more sense it makes to comment heavily. Again, code clarity needs to be a priority, but so does comment clarity, so much time is spent reading code by humans who are optimized to parse natural language. So we should cater to our users, not just the users of our executable, but the users of our source too!
Re: Stop Commenting Your Code
#9Earlier quoted context omitted.
Sarcasm? Or am I misunderstanding your comment? :) You annotate "every line"?
In most cases yes. I make sure the comments provide a complete plain language description of the program. Reading english (or whatever your native language is) is much much faster than parsing code.
It's not hard to understand what this.completePurchaseProcess(paymentInfo) does.
Re: Stop Commenting Your Code
#10Earlier quoted context omitted.
Could you be a little bit more constructive? It's okay if you disagree - but I'd be curious to hear your side.
I like your article and the example you used, code clarity is vital. Poor code is often accompanied by many poor comments which only helps in overwhelming the next poor soul who has to read the code. However, I think that the larger the project, the more sense it makes to comment heavily. Again, code clarity needs to be a priority, but so does comment clarity, so much time is spent reading code by humans who are opti…
Some commenting is okay and necessary. The point is that generally, if you are adding heavy commenting, you can probably refactor the code in such a way that commenting is not necessary. Even in a large codebase.