Comments¶

Status: ⏳ PENDING

The inverse of this chapter's rules — practices to recognize and avoid. Each will get a junior-level definition, a real example of the harm it causes, and the clean alternative.

Anti-Patterns to Cover¶

• Commented-out code left in source
• Redundant comments (// increment i above i++)
• Journal comments (// 2023-04-01: fixed by Alice) — git already does this
• Attribution comments (// added by Bob)
• Closing-brace comments (} // end if)
• Misleading or outdated comments that contradict the code

See the chapter README for the positive rules.