Commentaires C++ : Bonnes pratiques pour un code lisible et maintenable

Commentaires C++

Maîtrisez l'art du commentaire en C++ — apprenez pourquoi les commentaires importent, les deux styles principaux, et comment les utiliser pour un code plus clair et maintenable.

En C++, les commentaires sont des annotations qui aident les développeurs à lire et comprendre le code. Le compilateur les ignore entièrement, permettant aux développeurs d'ajouter du contexte, d'expliquer la logique, ou de désactiver temporairement du code.

Il y a deux façons standard d'ajouter des commentaires :

• // – Commentaires sur une ligne
• /* */ – Commentaires sur plusieurs lignes

---

Commentaires sur une ligne

Toute ligne qui commence par // est traitée comme un commentaire. Par exemple :

// Déclarer une variable
int a;
// Initialiser la variable 'a' avec la valeur 2
a = 2;

Dans l'extrait ci-dessus, les deux premières lignes sont des commentaires sur une ligne expliquant chaque étape. Vous pouvez aussi placer un commentaire à la fin d'une ligne de code :

int a; // Déclarer une variable

---

Commentaires sur plusieurs lignes

Tout ce qui se trouve entre /* et */ est un commentaire, s'étendant sur une ou plusieurs lignes. Exemple :

/*
 * Déclarer une variable
 * pour stocker le salaire des employés
 */
int salaire = 2000;

Cette syntaxe est assez flexible pour documenter à la fois des sections brèves et étendues de code.

---

Utilisation des commentaires pour le débogage

Les commentaires peuvent temporairement supprimer du code, ce qui est utile pour isoler les bogues. Considérez le programme suivant :

#include <iostream>
using namespace std;
int main() {
    cout << "du code";
    cout << ''code erreur;
    cout << "un autre code";
    return 0;
}

Si le programme ne compile pas, vous pouvez commenter la ligne problématique au lieu de la supprimer :

#include <iostream>
using namespace std;
int main() {
    cout << "du code";
    // cout << ''code erreur;
    cout << "un autre code";
    return 0;
}

Astuce Pro : La plupart des EDI permettent de basculer les commentaires rapidement — utilisez Ctrl + / sur Windows ou Cmd + / sur macOS.

---

Pourquoi utiliser des commentaires ?

Les commentaires servent de documentation vivante qui garde le code compréhensible pour vous-même et vos coéquipiers au fil du temps. Ils devraient clarifier le "pourquoi" derrière les décisions, pas simplement répéter ce que le code fait.

Note : Évitez de compter sur les commentaires pour expliquer du code mal écrit. Visez une logique claire et auto-explicative et utilisez les commentaires pour fournir du contexte là où c'est nécessaire.

Comme règle générale, utilisez les commentaires pour expliquer la raison d'être d'une solution, plutôt que la mécanique de l'implémentation.