MI
Minimal
Inline comments for complex logic only
Details
Language / Topic
_UUniversal
Category
Documentation
Rules
balanced
- Write self-documenting code with clear names and small functions — code should explain WHAT and HOW without comments.
- Add comments only for non-obvious WHY decisions (business rules, workarounds, trade-offs) — delete comments that restate the code.
- Delete outdated comments immediately — a wrong comment is worse than no comment. Keep docs in sync with code or remove them.
- Document complex algorithms, business rules, and non-obvious performance trade-offs inline.
- Keep a brief README with setup instructions, architecture overview, and key decisions.
- Never comment out code — delete it. Version control is your history.