Automatic Code Formatting

Note

A pull request will only be accepted if the C++ code is formatted correctly!

• To have one unified C++ code formatting style, we use clang-format.

• Clang-format automatically formats source code according to a set of pre-defined rules.

• Our current style can be found in the .clang-format file file in the root folder of the repository:

---
BasedOnStyle: LLVM
AccessModifierOffset: -4
AllowShortBlocksOnASingleLine: Empty
AllowShortCaseLabelsOnASingleLine: false
AllowShortFunctionsOnASingleLine: Empty
AllowShortIfStatementsOnASingleLine: Never
AllowShortLoopsOnASingleLine: false
AlwaysBreakTemplateDeclarations: Yes
ColumnLimit: 120
IndentWidth: 4

• We recommend to install plugins which auto format the code when the file is being saved.

• Instructions for how to enable clang-format in Microsoft Visual Studio can be found here.

• Other editors like Visual Studio Code, Notepad++ and Sublime Text support this as well.

• Part of our continuous integration (CI) is an automated clang-format check using GitHub actions.

• Our setup of clang-format with GitHub actions can be here.