TLDR Web Dev · OPINIONS & ADVICE

DO'S AND DON'TS OF COMMENTING CODE

blog.openreplay.com6 min read

Summary from the TLDR Web Dev newsletter

When commenting code, use consistent commenting standards, explain the "why" behind code rather than just the "what", and use annotations like TODO and FIXME for clear communication. Also, avoid common mistakes like commenting on obvious code, leaving outdated comments, and including personal or informal remarks.