diff --git a/src/roadmaps/software-design-architecture/content/100-clean-code-principles/index.md b/src/roadmaps/software-design-architecture/content/100-clean-code-principles/index.md index 81d8bb579..83f98b741 100644 --- a/src/roadmaps/software-design-architecture/content/100-clean-code-principles/index.md +++ b/src/roadmaps/software-design-architecture/content/100-clean-code-principles/index.md @@ -2,19 +2,16 @@ Clean code is code that is easy to read, understand, and maintain. It follows a set of principles that are designed to make the code more readable, testable, and less error-prone. Some of the key principles of clean code include: -1. Clarity: The code should be easy to read and understand. -2. Simplicity: The code should be as simple as possible, avoiding unnecessary complexity. -3. Comments: Comments should be used sparingly and only when necessary to explain complex or non-obvious code. -4. Naming: Variables, functions, and classes should have meaningful and descriptive names. -5. Formatting: The code should be consistently formatted to improve readability. -6. Functionality: The code should be organized into small, single-purpose functions and classes. -7. Error handling: The code should handle errors in a consistent and predictable way. -8. Testing: The code should be testable and have a high test coverage. -9. Reusability: The code should be designed to be reusable and modular. -10. Performance: The code should be designed to be efficient and performant. - -By following these principles, the system architecture will be more maintainable, testable, and less error-prone, and it will be easier to read and understand the code. - +- Clarity: The code should be easy to read and understand. +- Simplicity: The code should be as simple as possible, avoiding unnecessary complexity. +- Comments: Comments should be used sparingly and only when necessary to explain complex or non-obvious code. +- Naming: Variables, functions, and classes should have meaningful and descriptive names. +- Formatting: The code should be consistently formatted to improve readability. +- Functionality: The code should be organized into small, single-purpose functions and classes. +- Error handling: The code should handle errors in a consistent and predictable way. +- Testing: The code should be testable and have a high test coverage. +- Reusability: The code should be designed to be reusable and modular. +- Performance: The code should be designed to be efficient and performant. Learn more from the following links: