]> Kevux Git Server - fll/commitdiff
Update: Style guide documentation.
authorKevin Day <kevin@kevux.org>
Thu, 2 Mar 2023 04:02:48 +0000 (22:02 -0600)
committerKevin Day <kevin@kevux.org>
Thu, 2 Mar 2023 04:02:48 +0000 (22:02 -0600)
documents/style_guide.txt

index 17226753fbd39972a6b73266ecdf69c26e87d9f4..ccd8e685403be8c58344903898f21cddb6043483 100644 (file)
@@ -22,6 +22,7 @@ General Style Guides:
   - Commas in Sets.
   - Loops and Newlines.
   - Returns, Breaks, Continues, Gotos, and Newlines.
+  - Braces, Blocks, and One Liners.
 
 Specific Style Guides:
   - Return Code Names.
@@ -144,6 +145,21 @@ Returns, Breaks, Continues, Gotos, and Newlines:
 
   As an exception, this newline requirement may also be disregarded when combined with a set of one-line if, then, and else conditions.
 
+Braces, Blocks, and One Liners:
+  Most code, in general, is to be wrapped in bracks as appropriate for the needed or desired block structure.
+
+  There are seveal cases where one-liners are highler recommended and encouraged.
+  Operations that change the flow of a block, like a code:"return" statement or a code:"break" state make sense to be in a single line.
+
+  The one liner statements may also be on the immediate next line from relating code.
+
+  An example of the one liner looks like\:
+    block:"
+      if (x == 0) return;
+      if (x == 1) break;
+      if (x == 2) continue;
+    "
+
 Return Code Names:
   The return code names are C-language specific names used by this project as the status or return codes for functions and programs.
   To uniquely identify these, they follow the naming structure code:"(A)_(b)", where code:"(A)" is replaced with an upper-case character representing the project level (or name) and code:"(b)" is replaced with the lower-case status code name using words that are underscore separated.