Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

That is true if you read "comment" as "description". That is the weird connection in a lot of bad comment.

But in real life, what is truly a comment (https://en.wikipedia.org/wiki/Comment)? Is like in sports: A commenter talk about the game and add context to enrich the narrative of that game: "Mr. Jhon score a avg of NNN/MMM in this season"

A comment that is a description of what the code is doing, is redundant (if the language is not obscure). But as a "commentary" of the circumstances around that code, is useful:

"This code is a workaround of the BUG (url). TODO: Remove when it get solved".



In other words, comments should explain why something was done and now how.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: