Samples note: Use comments to describe what code does, not what you wish the code would do

14 · Raymond Chen · Sept. 25, 2025, 4:44 p.m.
Summary
This post emphasizes the importance of writing comments that accurately describe what the code does, rather than what the author wishes it would do. It serves as a reminder to developers that comments should enhance understanding of the actual implementation instead of introducing misleading or incorrect expectations.