Maîtriser les commentaires en C : Écrire des notes claires et efficaces

Qu'est-ce qu'un commentaire en C ?

Un commentaire est une explication ou description qui accompagne le code source. Il aide les développeurs à communiquer leur intention, améliorer la lisibilité et maintenir le code dans le temps. Lors de la compilation, le compilateur ignore simplement les commentaires, ils n'affectent donc pas les performances à l'exécution.

En C, il existe deux styles canoniques :

1. Commentaires de bloc, commençant par /* et se terminant par */. Ils peuvent s'étendre sur une seule ligne ou plusieurs lignes.
2. Commentaires sur une seule ligne, introduits par //. Tout ce qui suit les deux barres obliques sur cette ligne est ignoré par le compilateur.

Exemple de commentaire sur une ligne

// Ceci est un commentaire sur une seule ligne

Voici un programme minimal démontrant l'utilisation d'un commentaire sur une ligne :

#include <stdio.h>
int main(void) {
    // Ce qui suit affiche un message de bienvenue
    printf("Guru99");
    return 0; // Statut de sortie
}

Exemple de commentaire multi-lignes

/* Exemple de commentaire multi-lignes
Ligne 1
Ligne 2
... */

Voici un extrait réel mélangeant commentaires de bloc et commentaires en ligne :

#include <stdio.h>
int main() {
    /* Dans la fonction main, je décris la logique
       et met en évidence les étapes clés */
    int x = 42; // x est une variable entière
    printf("%d", x);
    return 0;
}

Pourquoi commenter ?

Écrire du code lisible par les humains est une pierre angulaire du développement logiciel professionnel. Les commentaires :

• Clarifient la logique complexe pour les futurs mainteneurs.
• Documentent les hypothèses, contraintes et comportements attendus.
• Facilitent la collaboration dans les équipes et projets open-source.
• N'impactent pas l'exécution du programme, tout en apportant une valeur à long terme.

Adopter des habitudes de commentaire disciplinées est considéré comme une meilleure pratique dans l'industrie et signale expertise, rigueur et engagement envers la qualité.