Conventions de codage C++

Sommaire :

• Principes généraux
• Conventions
• Casse
• Indentation
• Espaces
• Retours à la ligne
• Exemple de code
• Fichier de configuration pour Clang-format dans Visual Studio code

Principes généraux

L'objectif essentiel de mes conventions de codage est de maximiser la lisibilité du code.
Notamment :

• - La lecture du code doit, autant que possible, se rapprocher de phrases correctement construites et compréhensibles.
• - La casse et la typographie doivent faciliter la lecture et l'identification des éléments importants.

J'essaie de rester proche des conventions les plus communes.

La référence et la base sont les C++ Core Guidelines.

Conventions

Casse

• - Le snake_case est bien plus lisible que le camelCase (cf NL.10: Prefer underscore_style names).
• - Le nom d'une classe commence par une capitale (seulement pour le premier mot) (exemple : Ma_classe).
• - Le nom d'une méthode statique commence par une capitale (seulement pour le premier mot).
• - Le nom d'une constante commence par une capitale (seulement pour le premier mot).

Indentation

• - Les tabulations sont interdites.
• - 4 espaces par niveau d'indentation.
• - L'indentation des paramètres des fonctions, de la liste d'initialisation du constructeur, et du corps d'une fonction doivent permettre de distinguer visuellement ces différentes parties. Ainsi, on indentera de 8 caractères les paramètres car le corps est indenté de 4 caractères.

Espaces

• - , ; : : Comme en typographie anglaise, pas d'espace avant et une espace après pour les virgules, les points-virgules et les doubles points.
• - & * : Une espace avant et une espace après les esperluettes et les étoiles de référencement et de déréférencement.
• - opérateurs : Une espace avant et une espace après les opérateurs binaires comme unaires.

Retours à la ligne

• - Accolades égyptiennes (accolade ouvrante en fin de ligne, accolade fermante seule sur une ligne) (accolades toujours obligatoires).
• - Dans la signature d'une fonction (déclaration comme définition), un argument par ligne.
• - Dans la liste d'initialisation d'un constructeur, un membre par ligne.

Exemple de code

#include "A.hpp"
#include "B.hpp"

#include <string>

namespace foo {
namespace bar {
class C;

class D: public A {
public:
    D() = default;

private:
    int f;
};

D::D(int a,
        int b):
            A(12),
            f(42), g(12) {
    f += 12;
}

void compute(const D & d,
        int e) {
    int sum = 0;
    for (int i = 0; i < e; i ++) {
        sum += d.do(i);
    }

    long_call_to_a_funtion_with_seveval_parameters(first_parameter,
        second_parameter, third_parameter);

    int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
        = bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
        + cccccccccccccccccccccccccccccc;

    if (long_condition_filling_the_line()
        || foo()) {
    } else {
    }

    try {
        foo();
    } catch () {
    }

    switch (foo) {
        case 1:
            bar();
            break;
        default:
            baz();
    }

    for (auto v: values) {
    }
}

}
}

Fichier de configuration pour Clang-format dans Visual Studio code

Documentation de référence : Clang-Format Style Options.

Language: Cpp
AccessModifierOffset: -4
AlignAfterOpenBracket: DontAlign
AlignOperands: false
AllowShortFunctionsOnASingleLine: None
BinPackParameters: false
BreakBeforeBinaryOperators: All
BreakConstructorInitializers: AfterColon
ColumnLimit: 0
ConstructorInitializerIndentWidth: 12
FixNamespaceComments: false
IndentWidth: 4
IndentCaseLabels: true
PointerAlignment: Middle
SpaceAfterLogicalNot: true
SpaceBeforeCtorInitializerColon: false
SpaceBeforeInheritanceColon: false
SpaceBeforeRangeBasedForLoopColon: false
SpacesBeforeTrailingComments: 2
UseTab: Never

Notez que Clang-format ne permet pas d'avoir :

• - une espace avant les opérateurs unaires ;
• - une double indentation pour la liste des paramètres d'une fonction.

La dernière mise à jour de cette page date de mai 2020.

Le contenu de ce site est, en tant qu'œuvre originale de l'esprit, protégé par le droit d'auteur.
Pour tout commentaire, vous pouvez m'écrire à xavier.lamorlette@gmail.com.