Commit 1b18e49d authored by Dave Moxey's avatar Dave Moxey

More changes

parent 146a4111
BasedOnStyle: LLVM BasedOnStyle: LLVM
AlignAfterOpenBracket: true AlignAfterOpenBracket: true
AlignConsecutiveAssignments: true
IndentWidth: 4 IndentWidth: 4
BreakBeforeBraces: Allman BreakBeforeBraces: Allman
AllowShortBlocksOnASingleLine: false AllowShortBlocksOnASingleLine: false
......
...@@ -123,7 +123,8 @@ below this would be fantastic. ...@@ -123,7 +123,8 @@ below this would be fantastic.
} }
``` ```
- **Don't use preprocessor directives and macros unless there is no viable - **Don't use preprocessor directives and macros unless there is no viable
alternative.** The exception to this is header guards inside your `.h` files. alternative.** The exception to this is header guards inside your `.h` files,
which you should be sure to include in any headers you contribute.
- Use one `.cpp` and `.h` file per C++ class, and try to keep `inline` header - Use one `.cpp` and `.h` file per C++ class, and try to keep `inline` header
code to a minimum (unless performance is a major factor). code to a minimum (unless performance is a major factor).
- Put spaces around binary operators and constants. - Put spaces around binary operators and constants.
...@@ -131,10 +132,10 @@ below this would be fantastic. ...@@ -131,10 +132,10 @@ below this would be fantastic.
example above). example above).
### Variables and naming ### Variables and naming
- Please use sensible names! - Please use sensible names and use camelCase as a broad naming convention.
- Use camelCase to define your variable and function names, - Variables should start with a lowercase letter, e.g. `myAwesomeVariable`.
e.g. `myAwesomeVariable`. Any `typedef`s, function, `class` and `struct` names - Function, `class`, `struct` and `typedef` names should begin with capital
should begin with capital letters, variable names should be lower case. letters, e.g. `MyAwesomeFunction`.
- Inside classes, member variables should be prefixed with `m_`, - Inside classes, member variables should be prefixed with `m_`,
e.g. `m_myAwesomeVariable`. e.g. `m_myAwesomeVariable`.
- Global constants used throughout the library should be prefixed with `k` - Global constants used throughout the library should be prefixed with `k`
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment