DEV Community


Discussion on: //TODO: Write a better comment

syntaxseed profile image
SyntaxSeed (Sherri W)

Comments are valuable when they enable me to skip over reading a section of code.

Yes, clear, expressive code is important, but sorry to burst egos- I don't want to read every line of even beautiful code. I'm a busy woman.

Write comments to summarize sections & reveal gotchas & important details. It's just more efficient that way.

workingwebsites profile image
Lisa Armstrong

Agreed. Maybe comments are TLDR; for code? 😎