Comments and decisions

← Back to concept

Explain the reason

A useful comment records an invariant, a non-obvious constraint or an architectural decision. Do not narrate obvious code. Preserve existing comments unless the relevant decision has changed.

// Keep the source snapshot until every program is saved successfully
await import_programs(snapshot)

Choose names and contracts that make behavior readable without commentary. Document ownership and public guarantees near their owner. Keep operational commands and deployment-specific settings in operational documentation rather than product interfaces.