summaryrefslogtreecommitdiffstats
path: root/CodingStyle
diff options
context:
space:
mode:
authorGravatar Dirk Hohndel <dirk@hohndel.org>2014-01-16 11:50:56 +0700
committerGravatar Dirk Hohndel <dirk@hohndel.org>2014-01-16 11:50:56 +0700
commita27f67c02612791fad73b4e0550d942dc3a5a339 (patch)
tree4417a2be34c8bcd7c03db23ba5f307ad463657a9 /CodingStyle
parent3387ccc6f676636fe3fb8b11c8c371f627d74551 (diff)
downloadsubsurface-a27f67c02612791fad73b4e0550d942dc3a5a339.tar.gz
Whitespace and coding style updates
Another futile attempt to cleanup the code and make coding style and whitespace consistent. I tried to add a file that describes the key points of our coding style. I have no illusions that this will help the least bit... This commit should ONLY change whitespace Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Diffstat (limited to 'CodingStyle')
-rw-r--r--CodingStyle63
1 files changed, 63 insertions, 0 deletions
diff --git a/CodingStyle b/CodingStyle
new file mode 100644
index 000000000..9efd5f67a
--- /dev/null
+++ b/CodingStyle
@@ -0,0 +1,63 @@
+- all indentation is tabs (set to 8 char) with the exception of
+ continuation lines that are alligned with tabs and then spaces
+
+- all keywords followed by a '(' have a space in between
+
+ if (condition)
+
+ for (i = 0; i < 5; i++)
+
+- function calls do NOT have a space between their name and argument
+
+ i = some_function(argument);
+
+- usually there is no space on the inside of parenthesis (see examples
+ above)
+
+- function / method implementations have their opening curly braces in
+ column 1
+
+- all other opening curly braces follow at the end of the line, with a
+ space separating them:
+
+ if (condition) {
+ dosomething();
+ }
+
+- both sides of an if / else clause either use or do not use curly braces:
+
+ if (condition)
+ i = 4;
+ else
+ j = 6;
+
+ if (condition) {
+ i = 6;
+ } else {
+ i = 4;
+ j = 6;
+ }
+
+- use space to make visual separation easier
+
+ a = b + 3 + e / 4;
+
+- continuation lines have the operator / comma at the end
+
+ if (very_long_conditiont_1 ||
+ condition_2)
+
+ b = a + (c + d +
+ f + z);
+
+- unfortunate inconsistency:
+ -- C code usually uses underscores to structure names
+
+ variable_in_C
+
+ -- C++ code usually uses camelCase
+
+ variableInCPlusPlus
+
+ where the two meet, use your best judgment and go for best consistency
+ (i.e., where does the variable "originate")