Principle2 min
Code is for humans
the machine doesn't care about your variable names.
Names matter. Structure matters. Comments explain why, never what — the code already says what it does; the comment is where you confess the reason.
The person reading your code later is the real customer — and it's usually you, at 2am, wondering what you meant. Be kind to that person.
Good code reads like a letter from a thoughtful engineer. It's not about cleverness; it's about leaving the room clean enough that the next person can walk in without tripping.the machine doesn't care
the point is simple — the details are not.
further reading3 references
- ↳The Zen of Python
- ↳Code Complete — Steve McConnell
- ↳Clean Code — Robert C. Martin