Changes between Version 4 and Version 5 of CodingStandards

Timestamp:

Dec 31, 1969, 4:20:58 PM (54 years ago)

Author:

shauser

Comment:

--

CodingStandards

@@ -1 +1 @@
 = OpenSHA Coding Standards =
-Anyone working on OpenSHA should strive to write efficient, well-documented, and testable code. To facilitate uniform presentation and encourage a high level of readability, several syntactic standards to which this project adheres are outlined below. Most of the recommended syntax configurations can be set within your IDE of choice.
+Anyone working on OpenSHA should strive to write efficient, well-documented, and testable code. To encourage readability and uniform presentation, several syntactic standards to which this project adheres are outlined below. Most of the recommended syntax configurations can be set within your IDE of choice.
 
 == Syntax ==
@@ -10 +10 @@
 '''Line Wrapping''' : Indent wrapped lines with two tabs.
 
-'''Code Blocks''' : Code contained within a containing block shall always be indented by a single tab from the containing block. When creating a new block of code (i.e. functions, loops, if-statements, etc...), the opening bracket "{" shall be on the same line as the start of the block and the closing bracket shall be on its own line aligned to the opening indentation of that block. This is true except for when the code block can fit entirely on a single line, in such a case it is allowable to do so however there should be sufficient space for a leading ''and'' trailing space between the code-block body and the brackets. For example:
-
-Good
+'''Code Blocks''' : methods, for-loops, if-statements, etc... 
+ * The opening bracket "{" of any new block should be on the same line as the start of the block
+ * The closing bracket should be on its own line aligned to the opening indentation of the block.
+ * The only exception is the case of where the entire block can fit on one line, e.g.:
 {{{
-public void foo () {
-    ...
-}
-public boolean bar () { return true; }
-}}}
- 
-Bad
-{{{
-public void foo ()
-    {
-...
-    }
-public boolean bar(){return true;}
+if (false) return;
 }}}