Live data from Hacker News

How to comment your code better

1–3 of 3 posts

How to comment your code better

Post by sudeepjuvekar » Sun, Mar 09, 2008, 6:06 PM UTC

"Commenting your code is like cleaning your bathroom. You never want to do it, but it really does create a more pleasant experience for you and your guests... "

How to comment your code better
particletree.com

Re: How to comment your code better

Post by cstejerean » Sun, Mar 09, 2008, 9:11 PM UTC

Definitely try to write your code in self documenting form. A function name that makes it clear what the function does is better than a comment. Chances are comments start to rot very quickly as other programmers updating code are likely not to touch comments, or to copy and paste something and take a comment out context.

Re: How to comment your code better

Post by [deleted] » Mon, Mar 10, 2008, 9:32 PM UTC

cstejerean wrote: post #2

Definitely try to write your code in self documenting form. A function name that makes it clear what the function does is better than a comment. Chances are comments start to rot very quickly as other programmers updating code are likely not to touch comments, or to copy and paste something and take a comment out context.

[deleted]

Post reply on HN