TLDR Dev · OPINIONS & ADVICE

ON COMMENTS

blog.helsing.ai16 min read

Summary from the TLDR Dev newsletter

For the past decade, a unique syntax highlighting configuration has emphasized code comments by coloring them bright orange to encourage better documentation practices. While comments can often clutter code with unnecessary information, useful comments, like TODOs, correctness arguments, and rationale for specific choices, are invaluable for informing future developers and clarifying the reasoning behind the code.