Changes between Version 6 and Version 7 of ControlSystems/SoftwareTeam/CodingConventions


Ignore:
Timestamp:
Oct 31, 2019, 9:07:16 PM (6 years ago)
Author:
David Albert
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • ControlSystems/SoftwareTeam/CodingConventions

    v6 v7  
    33 * Never put cleverness before clarity
    44     * when choosing between a clever algorithm and one that will do the job and is easier to understand, use the latter.
     5 * 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.
    56 * Tool (and language) wars are for noobs
    67 * Being kind is better than being right
    78
    89== Coding Conventions ==
    9  * 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.
    1010 * Shift-Alt-F (auto-format)
    1111 * Make comments often about WHY, not what, you are doing