On Commenting Code
2024 February 23
In an ideal world there would be no need to comment code. We wouldn't have to spend time writing comments, rewriting comments, reading comments, or scrolling past comments to find the next block of code. Unfortunately, this is not the world we live in.
Code comments are a help line for your PR reviewer, your coworkers, and your future self that might just help them out on their darkest day. It can feel like a chore. Comments can even detract from your work when done poorly. But when done well, comments can be be immensely helpful.
Read More…