Annexes

Clang-Format

A propos de clang-format

Concernant la mise en forme de votre code, nous vous demandons d'utiliser l'outil clang-format en version 14, à définir.

Avertissement : Attention, la version par défaut de clang-format installée au CREMI (Debian 12) est la version 14, qui n'est pas forcément la version installée sur votre machine Linux.

Vous pouvez contrôler la version par défaut de clang-format installée sur votre machine comme ceci :

clang-format --version

Pour installer la version 14 sur une Debian/Ubuntu récente, tapez la commande :

sudo apt install clang-format-14

Pour générer un fichier .clang-format de style google en version 14, il faut alors de taper la commande suivante :

clang-format-14 -style=google -dump-config > .clang-format

Vous pouvez choisir un autre style et/ou adapter ce style à votre goût en modifiant les différentes options du fichier. La description précises des options est disponible dans la documentation.

Par exemple, vous pouvez modifier le nombre de caractères max par ligne en changeant la propriété suivante :

ColumnLimit:     120

Voici un exemple de fichier .clang-format que vous pouvez réutiliser à votre guise.

Pour mettre en forme vos fichiers sources, vous pouvez explicitement utiliser la commande suivante (en supposant qu'il y a le fichier .clang-format disponible dans le répertoire courant ou le plus proche parent) :

clang-format-14 -i *.c *.h

Dans Visual Studio Code, l'extension C/C++ de Microsoft propose d'utiliser nativement l'outil clang-format pour mettre en forme votre code en tapant dans la Command Palette (Ctrl+Shift+P) la commande Format Document, ou plus simplement en utilisant directement le raccourci Ctrl+Shift+I.

Pour prendre en compte un fichier de style .clang-format défini par l'utilisateur (et positionné à la racine de votre workspace), il faut modifier dans les Settings de VS Code (Ctrl+,) les options suivantes de l'extension C/C++ :

"C_Cpp.clang_format_style": "file"
"C_Cpp.clang_format_path": "/usr/bin/clang-format-14"

En résumé :

Vous pouvez également choisir d'ajouter l'option Format on Save dans les Settings de VS Code.