From 4c1a13bf0759f67f142830902b80c2990727ea04 Mon Sep 17 00:00:00 2001
From: David Capello <david@igarastudio.com>
Date: Tue, 4 May 2021 18:32:38 -0300
Subject: [PATCH] More info about coding style

---
 docs/CODING_STYLE.md | 61 ++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 56 insertions(+), 5 deletions(-)

diff --git a/docs/CODING_STYLE.md b/docs/CODING_STYLE.md
index 1c1fb8a30..43997b40c 100644
--- a/docs/CODING_STYLE.md
+++ b/docs/CODING_STYLE.md
@@ -5,18 +5,48 @@
 Basic statements:
 
 ```c++
-void global_function(int arg1, int arg2,
-                     int arg3, ...)
+void global_function(int arg1,
+                     const int arg2, // You can use "const" preferably
+                     const int arg3, ...)
 {
   int value;
   const int constValue = 0;
 
+  // We prefer to use "var = (condition ? ...: ...)" instead of
+  // "var = condition ? ...: ...;" to make clear about the
+  // ternary operator limits.
+  int conditionalValue1 = (condition ? 1: 2);
+  int conditionalValue2 = (condition ? longVarName:
+                                       otherLongVarName);
+
+  // If a condition will return, we prefer the "return"
+  // statement in its own line to avoid missing the "return"
+  // keyword when we read code.
+  if (condition)
+    return;
+
+  // You can use braces {} if the condition has multiple lines
+  // or the if-body has multiple lines.
+  if (condition1 ||
+      condition2) {
+    return;
+  }
+
   if (condition) {
     ...
+    ...
+    ...
   }
 
+  // We prefer to avoid whitespaces between "var=initial_value"
+  // or "var<limit" to see better the "; " separation. Anyway it
+  // can depend on the specific condition/case, etc.
   for (int i=0; i<10; ++i) {
     ...
+    // Same case as in if-return.
+    if (condition)
+      break;
+    ...
   }
 
   while (condition) {
@@ -61,17 +91,38 @@ Define classes with `CapitalCase` and member functions with `camelCase`:
 ```c++
 class ClassName {
 public:
-  ClassName();
+  ClassName()
+    : m_memberVarA(1),
+      m_memberVarB(2),
+      m_memberVarC(3) {
+    ...
+  }
+
   virtual ~ClassName();
 
+  // We can return in the same line for getter-like functions
   int memberVar() const { return m_memberVar; }
   void setMemberVar();
 
 protected:
-  void protectedMember();
+  virtual void onEvent1() { } // Do nothing functions can be defined as "{ }"
+  virtual void onEvent2() = 0;
 
 private:
-  int m_memberVar;
+  int m_memberVarA;
+  int m_memberVarB;
+  int m_memberVarC;
+  int m_memberVarD = 4; // We can initialize variables here too
+};
+
+class Special : public ClassName {
+public:
+  Special();
+
+protected:
+  void onEvent2() override {
+    ...
+  }
 };
 ```