Les commentaires

Objectif

  • Comprendre l'utilité des commentaires.

Mise en situation

Un programme qui s'allonge peut rapidement devenir difficile à relire, à comprendre et à modifier.

FondamentalCommentaires

Commenter son code est une bonne pratique à adopter pour conserver un code explicite : préciser le rôle d'une fonction, expliquer une opération réalisée sur plusieurs instructions, etc.

Les commentaires sont indispensables en particulier pour des programmes complexes, destinés à être réutilisés ou modifiés par plusieurs personnes ; ils permettent de rendre un programme ou un bloc de code plus clair en utilisant la langue naturelle (français, anglais, etc.).

Il existe trois types de commentaires en JavaScript :

  • Les commentaires en bloc ;

  • Les commentaires en ligne ;

  • Les commentaires de fin de ligne.

SyntaxeCommentaires en JavaScript

1
/*
2
  Commentaire en bloc
3
*/
4
5
// Commentaires en ligne
6
7
console.log('Hello World') // Commentaire de fin de ligne
Méthode
Pour être efficaces, les commentaires doivent donner suffisamment d'informations sans être trop détaillés. Pour cela :
  • Ne pas commenter chaque ligne mais plutôt un ensemble d'instructions qui effectuent une opération spécifique ou plutôt complexe.
  • Ne pas expliciter tous les détails comme le rôle des variables : pour cela, il est préférable de judicieusement choisir leur nom. Cela aidera à la compréhension sans alourdir de commentaires.
  • Les instructions commentées doivent en revanche être supprimées si elles ne sont pas vouées à être utilisées : les laisser ajoute inutilement des lignes et nuit à la compréhension.
ComplémentSupprimer temporairement des instructions
Les commentaires servent aussi à masquer temporairement des lignes de code que l'on souhaite temporairement ignorer, par exemple à des fins de tests ou pour isoler un problème. Cette méthode permet d'éviter de les supprimer de les réécrire ces même lignes.
À retenir
Les commentaires doivent expliciter ce qui ne l'est pas dans le code et ne doivent pas alourdir le code.