Commenter

Définition, exemples et bonnes pratiques

À retenir

  • Le code commenté n'est jamais exécuté par la machine.
  • C'est un outil essentiel pour la collaboration entre développeurs.
  • Cela permet de tester des variantes d'un programme sans supprimer le travail précédent.

En programmation, commenter consiste à marquer une portion de code pour qu'elle soit ignorée par l'ordinateur lors de l'exécution du programme. C'est un peu comme mettre une consigne entre parenthèses dans une recette de cuisine : le cuisinier la lit pour comprendre, mais elle ne fait pas partie des ingrédients à mélanger.

Étymologie

Issu du latin commentari (« réfléchir sur », « annoter »). En informatique, le terme a évolué pour désigner l'action d'insérer des notes explicatives ou de neutraliser du code grâce à des caractères spéciaux appelés balises de commentaire.

Exemples d'usage

  • En Python, ajouter un # devant une ligne pour expliquer le rôle d'une variable.
  • En HTML, entourer une section par <!-- et --> pour masquer temporairement un bouton sur une page web.
  • En C++ ou JavaScript, utiliser // pour désactiver une ligne de calcul qui provoque une erreur.

Cas d'usage

On utilise cette action pour deux raisons principales : la documentation (expliquer aux autres développeurs comment fonctionne le code) et le débogage (isoler une partie du programme qui pose problème sans l'effacer définitivement).

Bonnes pratiques

Évitez de commenter l'évidence (ne dites pas « ajoute 1 à x » pour la ligne x++). Privilégiez l'explication du « pourquoi » plutôt que du « comment ». Enfin, pensez à supprimer le code mort (le code commenté depuis longtemps qui ne sert plus) avant de livrer une version finale.

Synonymes

annoter neutraliser masquer documenter

Antonymes

décommenter activer

Conseil

Prenez l'habitude de commenter vos fonctions complexes dès le début. Si vous revenez sur votre code dans six mois, ces petites notes vous feront gagner un temps précieux pour comprendre votre propre logique.

Questions fréquentes

Est-ce que les commentaires ralentissent mon site ou mon logiciel ?

Non. Lors de la compilation ou de l'interprétation, les commentaires sont supprimés ou ignorés. Ils n'ont aucun impact sur la vitesse d'exécution.

Existe-t-il un raccourci clavier pour commenter rapidement ?

Oui, dans la plupart des éditeurs de code (comme VS Code), il suffit de sélectionner les lignes et de presser 'Ctrl + /' (ou 'Cmd + /' sur Mac).