jjmoore1970/commentwhynotwhat icon
public
Published on 6/23/2025
comment-why-not-what

[R] Comments that explain the reason behind code, not what it is doing.

Rules

[R] comments rule

  • Write comments that explain the reason behind code, not what it is doing.
  • Avoid repeating code in plain English.
  • Use comments to explain decisions, edge cases, or intent.