Code style and formatting

We aim for a consistent and readable coding style. You do not need to worry about styling if you use the right tools we present in the following.

C++

Use clang-format. Can be added to be automatically run on save in your editor / IDE:

Current style is defined in .clang-format.

A pre-commit hook for git checking the code formatting can be found here.

Python

Use black. Can be added to be automatically run on save in your editor / IDE:

black is also run by our pre-commit-hooks. To run manually:

pre-commit run black --all-files

This article was written by Lars Bilke. If you are missing something or you find an error please let us know. Generated with Hugo 0.74.3. Last revision: October 21, 2020
Commit: Added link to clang-format pre commit hook to doku page a38b90841  | Edit this page on