Code Documentation Style

What problem does it solve?

Writing code comments that explain why decisions were made and how complex logic works, rather than just describing what the code does, to improve long-term maintainability.

Core Features & Use Cases

• Self-documenting: Comments focus on intent, rationale, and high-level design decisions to help future readers.
• Minimal, evergreen: Avoids time-bound notes and noise; remains accurate as the code evolves.
• Guidance for architecture and tricky logic: Provides framing for non-obvious calculations and edge cases.

Quick Start

Craft evergreen, minimal comments that explain the rationale and high-level design decisions behind complex logic.