Coding Conventions

Coding Guidelines

PhASAR mostly adheres to the LLVM coding guidelines that can be found here:

• https://llvm.org/docs/CodingStandards.html

In addition, we kindly ask you to make use of our code formatting and transformation scripts before you check-in some code to PhASAR.

Please use the following script to format the source code based on the LLVM style.

$ cd PHASAR_ROOT
$ utils/run-clang-format.py

Use the following script to run some very useful clang-tidy checks (and automated fixes) on the entire code base. This script runs a lot of clang-tidy checks and may be potentially expensive. You may wish to run it only once in a while, but definitely before you check-in any code.

$ cd PHASAR_ROOT
$ utils/run-phasar-checks.sh

Please make use of our scripts to help unifying PhASAR's code base and to reduce potential merge conflicts.