微信扫一扫SOLID Principles and Clean Code - File Contents
This document is a mandatory guide to SOLID principles and clean code practices for all code implementations.
Main Components
This skill is made up of four detailed documents:
-
SOLID Principles in Detail - Explanation and comparison examples for the five design principles (Single Responsibility, Open/Closed, Liskov Substitution, Interface Segregation, Dependency Inversion). See @SOLID-PRINCIPLES.md.
-
Clean Code Basics - Fundamentals for everyday implementation: naming conventions, function design, reducing nesting, and eliminating magic numbers. See @CLEAN-CODE-BASICS.md.
-
Quality Checklist - Criteria for confirming adherence to design principles, detecting code smells, and deciding when to refactor. See @QUALITY-CHECKLIST.md.
-
Quick Reference - One-line summaries for rapid lookup, common mistakes and fixes, and code review points. See @QUICK-REFERENCE.md.
The Five SOLID Principles
The documentation systematically explains the patterns that underpin extensibility and maintainability, starting with the Single Responsibility rule that "there should be only one reason to change."
Related Supplementary Principles
The additional principles referenced — DRY, YAGNI, and KISS — also provide frameworks that increase the effectiveness of your design.