This document provides a set of examples to highlight C++ code formatting conventions adopted by BlueBrain HPC team.
- NSE Team also provides such document
You may follow the conventions described in the Google C++ Style Guide
access modifiers may be indented this way:
class Foo {
public:
Foo();
private:
int data;
};
AccessModifierOffset: -2
thisIsAVeryLongMethodName(thisIsTheFirstArgument,
andHereIsTheSecondArgument,
theThirdArgument,
theFourthArgument,
theFifthArgument);
AlignAfterOpenBracket: Align
int aaaa = 12;
int b = 23;
int ccc = 23;
AlignConsecutiveAssignments: False
int aaaa = 12;
float b = 23;
std::string ccc = 23;
AlignConsecutiveDeclarations: False
#define MY_MACRO \
blablablablablablablabla blablablablablablablablablablablablablabla \
blablablablablablablablablablablablablablablabla
AlignEscapedNewlinesLeft: True
int aaa = bbbbbbbbbbbbbbb +
ccccccccccccccc;
AlignOperands: True
int a; // My comment for a
int b = 2; // comment b
AlignTrailingComments: True
if (a) {
return;
}
AllowShortBlocksOnASingleLine: False
switch (a) {
case 1:
x = 1;
break;
case 2:
return;
case 3: return; // NOT THIS
}
AllowShortCaseLabelsOnASingleLine: False
class Foo {
void f() {
foo();
}
void f() {}
};
AllowShortFunctionsOnASingleLine: Empty
Break even for simple if statement and always put body inside braces.
See clang-tidy check readability-braces-around-statements
if (a) {
return;
}
AllowShortIfStatementsOnASingleLine: False
Break even for simple for and while statements and always put bodies
inside braces.
See clang-tidy check readability-braces-around-statements
while (true) {
continue;
}
AllowShortLoopsOnASingleLine: False
AAAA =
"bbbb"
"cccc";
AlwaysBreakBeforeMultilineStrings: True
template <typename T>
T foo() {}
template <typename T>
T foo(int aaaaaaaaaaaaaaaaaaaaa, int bbbbbbbbbbbbbbbbbbbbb) {}
AlwaysBreakTemplateDeclarations: True
class Foo {};
struct Bar {
int i;
};
BraceWrapping.AfterClass: False
if (foo()) {
} else {
}
for (int i = 0; i < 10; ++i) {
}
BraceWrapping.AfterControlStatement: False
enum X : int { A, B, C };
BraceWrapping.AfterEnum: False
extern "C" {
int foo();
}
BraceWrapping.AfterExternBlock: False
void foo() {
bar();
bar2();
}
BraceWrapping.AfterFunction: False
namespace {
int foo();
int bar();
} // namespace
BraceWrapping.AfterNamespace: False
struct foo {
int x;
};
BraceWrapping.AfterStruct: False
union foo {
int x;
}
BraceWrapping.AfterUnion: False
try {
foo();
} catch () {
}
BraceWrapping.BeforeCatch: False
if (foo()) {
} else {
}
BraceWrapping.BeforeElse: False
When a break is required, the binary operator is the last token of the line.
LooooooooooongType loooooooooooooooooooooongVariable = someLooooooooooooooooongFunction();
bool value =
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa > ccccccccccccccccccccccccccccccccccccccccc;
BreakBeforeBinaryOperators: False
veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongDescription ? firstValue
: SecondValueVeryVeryVeryVeryLong;
BreakBeforeTernaryOperators: True
vector<int> x{1, 2, 3, 4};
vector<T> x{{}, {}, {}, {}};
f(MyMap[{composite, key}]) new int[3]{1, 2, 3};
Cpp11BracedListStyle: True
namespace bbp {
foo();
}
void f() {
someFunction();
if (true, false) {
f();
}
}
IndentWidth: 4
namespace out {
int i;
namespace in {
int i;
}
} // namespace out
NamespaceIndentation: None
int* a;
int& b = getB();
PointerAlignment: Left
- System headers
- Dependencies
- Current project
#include <algorithm>
#include <vector>
#include <pybind11/numpy.h>
#include <spdlog/spdlog.h>
#include "mylib/myclass.h"
SortIncludes: True
- Use 4 tab size
- Never use tab
// a space is inserted after C style casts
(int) i;
// a space is inserted after the template keyword
template <int>
void foo();
// a space a space before assignment operators
int a = 5;
a += 42;
// do not put spaces before C++11 braced list
Foo foo{bar};
Foo{};
vector<int>{1, 2, 3};
new int[3]{1, 2, 3};
// do not add space before constructor initializer colon
Foo::Foo()
: a(a) {}
// do not add space before inheritance colon
class Foo: Bar {
}
// put a space before opening parentheses after control statement
// (for/if/while...)
void f() {
if (true) {
f();
}
}
// do not add space before ranged-based for loop colon
for (auto v: values) {
}
// do not have space between `()`
void f() {
int x[] = {foo(), bar()};
if (true) {
f();
}
}
// put {{ cf['SpacesBeforeTrailingComments']}} spaces before trailing comment
void f() {
if (true) { // foo1
f(); // bar
} // foo
}
// do not add space after `<` and before `>`
static_cast<int>(arg);
std::function<void(int)> fct;
// do not add space inside C-style cast
x = (int32) y;
// do not add space insert `(` and before `)`
t f(Deleted&) & = delete;
// do not add space after `[` and before `]`
int a[5];
SpaceAfterCStyleCast: TrueSpaceAfterTemplateKeyword: TrueSpaceBeforeAssignmentOperators: TrueSpaceBeforeCpp11BracedList: FalseSpaceBeforeCtorInitializerColon: FalseSpaceBeforeInheritanceColon: FalseSpaceBeforeParens: ControlStatementsSpaceBeforeRangeBasedForLoopColon: FalseSpaceInEmptyParentheses: FalseSpacesBeforeTrailingComments: 2SpacesInAngles: FalseSpacesInCStyleCastParentheses: FalseSpacesInContainerLiterals: FalseSpacesInParentheses: FalseSpacesInSquareBrackets: FalseTabWidth: 4UseTab: Never
HighFive::DataSet dump(HighFive::File& file,
const std::string& path,
const std::vector<T>& data,
HighFive::Mode mode = HighFive::Mode::Create);
void andALongFunctionName(the_long_parameter1, the_long_parameter2);
AllowAllParametersOfDeclarationOnNextLine: FalseBinPackParameters: False
CLion allows you to disable their formatting engine to get
setting from CLangFormat:
in Settings > Editor > Code Style > C/C++, enable
Enable ClangFormat support (only for C/C++/ObjectiveC) checkbox.