Context Navigation

CodingConventions

-                      v9
+                      v10
      * when choosing between a clever algorithm and one that will do the job and is easier to understand, use the latter.
  * 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.
+ * Use meaningful names
+    * Function/method names and parameters should convey what they do.  For example:
+        * move_arm(int direction);
+    * Variable/data member names should convey what they store including units if appropriate.  For example
+        * int target_position_degrees;
+ * Comments should explain WHY.  For example:
+    * bad comment: int target_position_degrees; !// target position in degrees
+    * good comment: int target_position_degrees; !// angle where arm should stop moving
  * Tool (and language) wars are for noobs
  * Being kind is better than being right