Changes between Version 3 and Version 4 of ControlSystems/SoftwareTeam/CodingConventions
- Timestamp:
- Oct 31, 2019, 9:03:15 PM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ControlSystems/SoftwareTeam/CodingConventions
v3 v4 1 * Design from the top down, build from the bottom up 1 == Rules to Live (and code) By == 2 * Design from the top down, build from the bottom up 3 * Never put cleverness before clarity 4 * when choosing between a clever algorithm and one that will do the job and is easier to understand, use the latter. 5 * Being kind is better than being right 2 6 3 7 == Coding Conventions == 4 * Never put cleverness before clarity5 * when choosing between a clever algorithm and one that will do the job and is easier to understand, use the latter.6 8 * Understand [https://www.agile-code.com/blog/cohesion-vs-coupling-separate-concerns/ coupling vs. cohesion] deeply. These are the two most important concepts in software engineering, everything else is an attempt to increase cohesion and reduce coupling. Every block of code (class or function) should be a stand-alone black box with cleanly defined inputs and outputs. You should not need several files open to understand how one method works. 7 9 * Shift-Alt-F (auto-format)