News for hackers. Stuff that matters.

A comment on The Shapes of Code. Parent comment

Re:The Shapes of Code by minaa-chan on Tuesday January 28, 2020 @09:26AM (#22169605)
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.

[ Parent | on HN ]
Re:The Shapes of Code by CraigJPerry on Tuesday January 28, 2020 @04:59PM (#22174546)
The comments are very often not true, that's why there's so much push back
[ Parent | on HN ]
Re:The Shapes of Code by minaa-chan on Wednesday January 29, 2020 @11:27AM (#22182288)
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.
[ Parent | on HN ]