Clean Code: Difference between revisions
Created page with "== KISS == '''Keep It Sweet & Simple''' - Simplicity is paramount. Methods should be concise, with one expression per line, and names should be meaningful. Classes should be focused and manageable in size to facilitate ease of change. The balance between readability and conciseness is essential. == DRY == '''Don't Repeat Yourself''' - Redundancy is a significant obstacle to clean code and system performance. Identifying and eliminating repetitive patterns is crucial for..." |
No edit summary |
||
| Line 1: | Line 1: | ||
== KISS == | == KISS == | ||
'''Keep It Sweet & Simple''' - Simplicity is paramount. Methods should be concise, with one expression per line, and names | '''Keep It Sweet & Simple''' - Simplicity is paramount. Methods should be concise, with one expression per line, and names MUST be meaningful. ⚠ DO NOT USE X, DO NOT USE VALUE, DO NOT USE LIST, etc. so not too simple ⚠ Classes should be focused and manageable in size to facilitate ease of change. The balance between readability and conciseness is essential. | ||
== DRY == | == DRY == | ||
Revision as of 08:10, 17 January 2025
KISS
Keep It Sweet & Simple - Simplicity is paramount. Methods should be concise, with one expression per line, and names MUST be meaningful. ⚠ DO NOT USE X, DO NOT USE VALUE, DO NOT USE LIST, etc. so not too simple ⚠ Classes should be focused and manageable in size to facilitate ease of change. The balance between readability and conciseness is essential.
DRY
Don't Repeat Yourself - Redundancy is a significant obstacle to clean code and system performance. Identifying and eliminating repetitive patterns is crucial for efficient and maintainable code.
YAGNI
You Ain't Gonna Need It - Solutions should be pragmatic and focused on current requirements. Extraneous features should be avoided unless they are necessary. It is important to remain open to potential future changes and to share any concerns with the team.
DTSTTCPW
Do The Simplest Thing That Could Possibly Work - This principle suggests starting with the most straightforward solution that solves the problem. It is particularly useful for complex problems, helping to clarify understanding and prevent over-engineering.
STUPID
Simple, Testable, Ubiquitous, Proper, Incremental, Decoupled - This acronym serves as a reminder of what to avoid in code. Striving for the opposite of these qualities ensures code is maintainable and efficient. [medium.com Smart Programmers Write STUPID Code](https://bdicroce.medium.com/smart-programmers-write-stupid-code-397765a14b14)
AddyOsmani.com Good code is like a love letter to the next developer who will maintain it.
