Formatage
Remonter à Options C++
Outils > Options > Langage > C++ > Formatage
Sommaire
Options de formatage C++
Le formateur de code permet de changer la disposition du code : il s'agit de choix stylistiques comme l'emplacement des nouvelles lignes ou des accolades, le nombre et le type d'éléments indentés, etc.
Généralement, ce formatage est effectué pour s'adapter à un standard de codage commun, personnalisé ou spécifique à l'entreprise. C++Builder l'implémente par le biais de l'outil clang-format.
Formatez le code dans l'éditeur (code sélectionné, unité complète) ou via un outil en ligne de commande. Le formatage dans l'EDI est utile pour formater le code sur lequel vous êtes en train de travailler. L'outil en ligne de commande se prête au formatage automatique lors de la validation du code, du formatage du code en bloc, ou d'opérations similaires.
Dans les pages situées sous C++, vous pouvez définir les options à utiliser dans les projets C++ pour les fichiers de code source C/C++ avec les extensions suivantes : *.cpp, *.cxx, *.cc, *.c, *.hpp, *.hxx, *.hh, *.h.
Comportement du formatage
| Elément | Description |
|---|---|
|
Formatage automatique |
Formatez le code manuellement ou automatiquement lors de l'enregistrement ou de l'ajout d'une nouvelle ligne. Choisissez parmi :
|
|
Limite du nombre de lignes à formater à l'ajout d'une ligne |
Si vous choisissez de formater automatiquement à l'ajout d'une ligne, le formateur n'est pas appelé et le formatage n'est pas appliqué si le code dépasse ce nombre de lignes. Cela s'explique par le fait que l'outil clang-format met beaucoup de temps à formater des unités plus longues. La valeur par défaut est définie sur 1000. |
|
Style de formatage |
Cliquez sur le menu déroulant pour afficher la liste des styles de formatage prédéfinis : Formatage personnalisé Vous pouvez créer des paramètres prédéfinis clang qui s'affichent dans ce paramètre comme les paramètres Embarcadero, Mozilla, etc. par défaut, ou redéfinir les paramètres de format projet par projet. Redéfinitions par projet La convention clang-format est utilisée dans les projets pour spécifier le style de formatage dans un fichier de configuration de formatage S'il ne trouve aucun fichier de configuration, l'EDI utilise le style défini par ce paramètre à la place. Cela signifie que les paramètres de l'EDI sont utilisés sauf s'ils sont redéfinis par projet et que l'EDI applique les redéfinitions par projet en se basant sur la convention fournie par un fichier Nouvelle configuration à l'échelle de l'EDI Vous pouvez créer de nouveaux fichiers de configuration stockant les options du formateur et les mettre à disposition dans l'EDI comme solution alternative pour tous les projets. Pour ce faire, le fichier doit :
Ainsi, le nom du formateur apparaît en tant qu'option dans le paramètre "Style de formatage". Modifiez ou créez des fichiers sur la base de configurations pré-existantes. Pour de plus amples informations sur l'écriture d'un fichier de configuration, voir Clang Format Style Options (Options de style clang-format). Remarque: Les nouveaux fichiers apparaissent dans le menu déroulant Style de formatage lors du démarrage suivant de l'EDI.
|
|
Afficher le dialogue de confirmation |
Si cette case est sélectionnée, le message d'invite de confirmation apparaît lorsque vous exécutez une commande de formatage. |
Empêcher le formatage
Empêchez le formatage de sections spécifiques en encadrant le code à ne pas formater des commentaires suivants :
// clang-format off Code here will not be formatted // clang-format on
La désactivation du formatage via un commentaire suspend le formatage jusqu'à la découverte du prochain commentaire 'on'. Vous pouvez utiliser des commentaires au format mono-ligne (//) ou multi-lignes (/**/).
Ligne de commande clang-format
Vous pouvez appeler le formateur sur la ligne de commande. Il se nomme clang-format.exe. Clang-format ne fournit aucune option permettant de choisir un fichier de configuration de formatage, et recherche toujours un fichier .clang-format en local. Donc, pour utiliser le style de formatage Embarcadero, vous devez copier Embarcadero.clang-format dans votre dossier source, puis le renommer en .clang-format.