Clean code is code that's easy to understand and easy to change. It's not about cleverness—it's about clarity. Here are principles that make code clean.
Meaningful Names#
Use Intention-Revealing Names#
Loading code block...
Avoid Abbreviations and Single Letters#
Loading code block...
Use Pronounceable Names#
Loading code block...
Functions#
Keep Functions Small#
Loading code block...
Do One Thing#
Loading code block...
Limit Parameters#
Loading code block...
Comments#
Code Should Be Self-Documenting#
Loading code block...
Don't Comment Bad Code—Rewrite It#
Loading code block...
Good Comments#
Loading code block...
Error Handling#
Use Exceptions, Not Return Codes#
Loading code block...
Don't Return Null#
Loading code block...
Classes#
Single Responsibility Principle#
Loading code block...
Keep Classes Small#
Loading code block...
Formatting#
Consistent Style#
Loading code block...
Tests#
Clean Tests Follow F.I.R.S.T#
Loading code block...
The Boy Scout Rule#
"Leave the code cleaner than you found it."
Every time you touch code:
- Rename a confusing variable
- Extract a small function
- Remove dead code
- Add a clarifying comment
Small, continuous improvements compound over time.
Conclusion#
Clean code isn't about following rules mechanically—it's about empathy for the next developer (including future you). Write code that tells a story, that's easy to navigate, and that doesn't require heroics to understand.
Start small: improve one thing in every file you touch. Over time, the codebase transforms.