Hacker News new | ask | show | jobs
by minaa-chan 2337 days ago
I disagree. The code is the best place to comment the why. Regardless of what is documented or what is written up on jira or w/e, the code is what is true.

Commenting the purpose of the code and maybe a link to some documentation allows a future reader to see if the code still fulfills the requirements.

1 comments

The comments are very often not true, that's why there's so much push back
So they should be updated the same as any other documentation. They're there to help. They don't need to be 100% infallible to be useful.