Programmation C++/Les commentaires

Tout bon programme a des fichiers sources bien commentés pour expliquer comment cela fonctionne et pourquoi certains choix ont été faits. Ce qui évite une perte de temps lorsque le code source est repris et modifié, soit par un autre développeur, soit par l'auteur qui ne se souvient pas forcément de son projet s'il n'y a pas touché depuis longtemps.

Programmation C++

• Avant-propos
• Introduction
• Compilation
• Un premier programme
• Les commentaires
• Le préprocesseur
• Les types de base et les déclarations
  • Exercices
• Les opérations de base
• Les entrées-sorties
• Les pointeurs
  • Exercices
• Les références
• Les tableaux
  • Exercices
  • Exercices sur les tableaux statiques
  • Exercice : Tris des tableaux à une dimension
  • Solution : Tris des tableaux à une dimension
• Les structures de contrôle
  • Exercices
  • Exercices if...else et switch
• Les fonctions
  • Exercices
• Les structures
  • Exercices
• Les classes
  • Exercices
  • Exercices de développement
• Les espaces de noms
• Les exceptions
• Les templates
  • Exercices
• Conventions d'appel
• Les fichiers
• La librairie standard
• Expressions rationnelles
• Interfaces graphiques
• Bibliographie et liens

Annexes

• Dessiner des formes : les bibliothèques graphiques

Anciennes pages

• Opérateurs
• Héritage
• Polymorphisme

Bloc de commentaire

Un bloc de commentaire est délimité par les signes slash-étoile /* et étoile-slash */ comme en Java et en C#. Exemple :

/*
    Un commentaire explicatif
    sur plusieurs lignes...
*/

Les blocs ne peuvent être imbriqués car dès que le compilateur trouve slash-étoile /*, il recherche la première occurrence d'étoile-slash */ terminant le commentaire.

Ce code contient une erreur volontaire !

/* : début du commentaire

    /* : ignoré

    fin du commentaire : */

erreur ici car le commentaire est fini : */

Commentaire de fin de ligne

Un commentaire de fin de ligne débute par un double slash // et se termine au prochain retour à la ligne. Exemple :

x++;  // augmenter x de 1

Le commentaire ne doit pas paraphraser le code, mais expliquer le rôle de cette partie du code, comme par exemple :

x++;  // décaler le point d'un pixel vers la droite

Astuce : La majorité des éditeurs évolués (Visual Studio, Borland C++, Eclipse ...) utilisent ce type de commentaire pour les commandes commenter/décommenter le groupe de lignes sélectionnées.