ALICE O2 Coding Guidelines

Coding guidelines for the ALICE O2 project.

Documents

• Coding guidelines
• Naming and formatting conventions
• Comments guidelines

ClangFormat

ClangFormat can be used to format your source code. The configuration file. We provide to files, one for clang 4.4 and one for the versions above.

• _clang-format (< 4.5)
• _clang-format (>= 4.5)

To use it (example for SLC6) :

sudo yum install clang
cd <source code location>
cp _clang-format-44 ../.clang-format
clang-format -style=file -i SOURCEFILE # -i if you want to replace content

Configuration files for editors

Eclipse

1. Download,
2. Go to Project->Properties->C/C++ General->Formatter,
3. Select the option "Enable project specific settings",
4. Click on the "Import..." button.

CLion

1. Download,
2. Go to File -> Import Settings.

FAQ

• Q I strongly disagree with rule X !
• A Feel free to contact the CWG11 ([email protected]) to share your concern(s). Rules have already been amended, abandoned or added based on the users feedback. However, please comply with the rules until a change is agreed by CWG11.