Les éléments les plus importants d'une norme de codage C++ légère

Question

J'ai participé à l'élaboration de normes de codage assez élaborées. D'après ma propre expérience, il est difficile de les faire respecter si l'on ne dispose pas de processus appropriés pour les maintenir et de stratégies pour les faire respecter.

Aujourd'hui, je travaille et je dirige un environnement où il est encore moins probable que des processus et des stratégies de suivi soient mis en place depuis longtemps. Je veux néanmoins maintenir un niveau minimum de code respectable. J'ai donc pensé que je pourrais obtenir de bonnes suggestions ici, et que nous pourrions ensemble produire un sous-ensemble raisonnable et léger des pratiques standard de codage les plus importantes pour que d'autres puissent l'utiliser comme référence.

Donc, pour souligner l'essentiel ici :

Quels éléments d'une norme de codage C++ sont les plus importants à respecter ?

• Règles de réponse/vote

  • 1 candidat par réponse, de préférence avec un bref motivation.

  • Vote négatif candidats qui se concentrent sur le style et les directives de formatage subjectives. Il ne s'agit pas d'indiquer qu'elles sont sans importance, mais seulement qu'elles sont moins pertinentes dans ce contexte.

  • Vote négatif les candidats se concentrant sur la manière de commenter/documenter le code. Il s'agit d'un sujet plus vaste qui pourrait même mériter son propre billet.

  • Votez pour des candidats qui facilitent clairement un code plus sûr, qui minimise le risque de bogues énigmatiques, qui augmente la maintenabilité, etc.

  • Ne votez pas dans n'importe quelle direction sur les candidats dont vous avez des doutes. Même s'ils semblent raisonnables et intelligents, ou au contraire "quelque chose que personne n'utiliserait", votre vote doit être basé sur une compréhension claire et une expérience.

Answer 1

Préférez RAII .

Les pointeurs auto (et partagés dans boost et C++0x) de STL peuvent aider.

Answer 2

Utilisez const par défaut. Ils offrent des garanties au lecteur/mainteneur, et sont beaucoup plus faciles à intégrer qu'à insérer après coup.

Les variables membres et les méthodes sont déclarées const ainsi que des arguments de fonction. const Les variables membres imposent une utilisation correcte de la liste d'initialisation.

Un effet secondaire de cette règle : éviter les méthodes avec des effets secondaires.

------ EDIT

const membre variables semblent être une bonne idée ; ce n'est pas toujours le cas : ils rendent effectivement cualquier objet immuable. Cela devient problématique pour, par exemple, trier un vecteur.

struct A {
    const int i;
};

bool operator<(const A& lhs, const A& rhs) {
    return lhs.i < rhs.i;
}

int main() {
    std::vector<A> as;
    as.emplace_back(A{1});
    std::sort(begin(as), end(as));
}

message d'erreur :

... note: copy assignment operator of 'A' is implicitly deleted because
field 'i' is of const-qualified type 'const int'
...
in instantiation of function template specialization 'std::sort<...>'
requested here

    std::sort(begin(as), end(as));

Answer 3

Utiliser les casts C++ au lieu des casts C

utiliser :

• static_cast
• const_cast
• reinterpret_cast
• dynamic_cast

mais jamais les casts de style C.

Comment cela facilite clairement un code plus sûr, qui minimise le risque de bogues énigmatiques, qui augmente la maintenabilité, etc.

Chaque acteur a des pouvoirs limités. Par exemple, si vous voulez supprimer un const (pour une raison quelconque), const_cast ne changera pas le type en même temps (ce qui pourrait être un bug difficile à trouver).

Cela permet également à l'examinateur de les rechercher et au codeur de les justifier si nécessaire.

Answer 4

Utilisez des références au lieu de pointeurs lorsque cela est possible. Cela évite les contrôles défensifs constants de NULL.

Answer 5

Assurez-vous que le niveau d'avertissement de votre compilateur est suffisamment élevé (/Wall de préférence) pour qu'il puisse repérer les erreurs stupides telles que :

if (p = 0)

alors que tu voulais vraiment

if (p == 0)

pour que tu n'aies pas besoin de recourir à des trucs encore plus stupides :

if (0 == p)

qui dégradent la lisibilité de votre code.