News for hackers. Stuff that matters.
Re:Best practices for writing code comments by skrtskrt on Friday December 24, 2021 @04:02PM (#29677702)
I always say more generally “explain the why”, business OR technical reasons.

Bigger architecture decisions should go in ADRs (again, explain the why) but smaller stuff like explaining why you monkeypatched a library can save future devs a lot of lost investigation time and pain. Maybe by the time they are reading your comment/code, the patch you wrote is supported in the main library!

There are no comments on this comment yet.