Clean Code Cheatsheet31 Mar 2019 6 minute read edit
“Writing clean code is what you must do in order to call yourself a professional. There is no reasonable excuse for doing anything less than your best”. - Robert C. Martin
Code is clean if it can be understood easily – by everyone on the team. Clean code can be read and enhanced by a developer other than its original author. With understandability comes readability, changeability, extensibility and maintainability.
This post is heavily based on the excellent summary from here, along with additional parts that I picked up from Clean Code.
- Follow standard conventions.
- Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
- Boy scout rule. Leave it cleaner than you found it.
- Always look for the root cause of a problem.
- Keep configurable data at high levels.
- Prefer polymorphism to if/else or switch/case.
- Separate multi-threading code.
- Prevent over-configurability.
- Use dependency injection.
- Follow Law of Demeter. A class should know only its direct dependencies.
Ashould not know about
- Avoid feature envy. Let the object do the calculation.
- Favour structure over convention. Make it hard to do it wrong.
- Be consistent. If you do something a certain way, do all similar things in the same way.
- Use explanatory variables.
- Encapsulate boundary conditions. Boundary conditions are hard to keep track of. Put the processing for them in one place.
- Prefer dedicated value objects to primitive type.
- Avoid logical dependency. Don’t write methods which work correctly depending on something else in the same class.
- Avoid negative conditionals.
- Encapsulate conditionals.
- Keep code at the same level of abstraction. Don’t mix high and low-level concepts.
- Avoid temporal coupling. Make it hard to call your API incorrectly. If unavoidable, make a method expect the input of the ‘necessary’ method.
- Choose descriptive and unambiguous names.
- Describe side effects.
- Choose appropriate names for the level of abstraction.
- Replace magic numbers with named constants.
- Avoid encodings. Don’t append prefixes or type information.
- Do one thing.
- Use descriptive names.
- Prefer fewer arguments.
- Have no side effects.
- Don’t use flag arguments. Split method into several independent methods that can be called from the client without the flag.
- Avoid output arguments.
- Avoid surprises. It should do what it says.
- Should only descend one level of abstraction.
- Always try to explain yourself in code.
- Don’t be redundant - is information already in source control?
- Don’t add obvious noise - be brief.
- Don’t use closing brace comments.
- Don’t comment out code. Delete it.
- Use as explanation of intent.
- Use as clarification of code when code cannot.
- Use as warning of consequences.
Source code structure
- Separate concepts vertically.
- Related code should appear vertically dense.
- Declare variables close to their usage.
- Dependent functions should be close.
- Similar functions should be close.
- Keep lines short.
- Don’t use horizontal alignment.
- Use white space to associate related things and disassociate weakly related.
- Don’t break indentation.
Objects and data structures
- Hide internal structure.
- Prefer data structures.
- Avoid hybrids structures (half object and half data).
- Should be small.
- Do one thing.
- Small number of instance variables.
- Base class should know nothing about their derivatives.
- Better to have many functions than to pass some code into a function to select a behaviour.
- Prefer (public) non-static methods to static methods. Unless you’re certain you won’t need polymorphic behaviour.
- Keep interfaces tight and small.
- One assert per test.
- Rigidity. The software is difficult to change. A small change causes a cascade of subsequent changes.
- Fragility. The software breaks in many places due to a single change.
- Immobility. You cannot reuse parts of the code in other projects because of involved risks and high effort.
- Needless Complexity.
- Needless Repetition.
- Opacity. The code is hard to understand.
For more details, I would strongly recommend reading the book. I have also made a full list of notes from every chapter, which might provide a place for comparison.
To end it all, what is clean code? Well, there are various definitions for clean code. It is subjective, but here is my favourite:
“Clean code always looks like it was written by someone who cares. There is nothing obvious that you can do to make it better. All of those things were thought about by the code’s author, and if you try to imagine improvements, you’re led back to where you are, sitting in appreciation of the code someone left for you - code left by someone who cares deeply about the craft.” - Michael Feathers