Simplified Clean Code Principles

Uncle Bob’s book "Clean Code" gives important advice for writing good code. Here’s a simple breakdown of these key principles:

1. No Code Comments

• Your code should be clear enough that it doesn’t need comments.
• Use good names for variables, methods, and other parts so anyone reading the code can understand what it does.

Rule: "Comments in code are a bad sign, get rid of them."

2. Remove Unused Code or Comments

• Delete any code or comments that you’re not using.
• Use version control systems to keep track of changes and deletions.

3. Test Boundaries

• Always test the edges of your code, like where different parts interact or where your code talks to an external system.
• Don’t assume these parts will work without testing.

4. Use Positive Conditionals

• Write conditions in a positive way because they are easier to read.
• For example, use “if (isValid)” instead of “if (!isInvalid)”.

5. Follow Standards

• Stick to the established rules for how to structure and write your code.
• Use tools like Linters, Formatters & Code Analysers to help you check if you’re following these standards.

6. Consistent Naming

Give your variables, methods, and classes clear, consistent names that make sense from the perspective of someone using them.

7. Keep It Simple

• Don’t make your code more complicated than it needs to be.
• Simple code is easier to understand and maintain.

8. Use Exceptions for Errors

• If something goes wrong in your method, throw an exception instead of returning a special code or null.
• This makes error handling clearer.

9. Keep Things Small

• Methods and classes should be short and focused.
• Ideally, methods should be less than 100 lines long.
• Smaller pieces of code are easier to manage.

10. Improve the Code

• Always try to leave the code better than you found it.
• Don’t wait for permission to clean up or improve the code when you see something that needs fixing.

Conclusion

These principles help you write readable, understandable, and maintainable code, benefiting everyone who works on it, including your future self. Adjust them with care as you gain experience.