Un commentaire JavaScript permet aux développeurs de ne pas faire afficher une partie de code. Ainsi, cette partie ne sera pas interprétée par le navigateur.
Ils sont mis dans le code et permettent d’apporter des précisions sur les fonctionnalités qui arrivent à la suite. Ils permettent également d’ignorer une partie de code sans pour autant la supprimer afin de pouvoir réactiver au besoin cette partie.
Le commentaire en JavaScript peut s’écrire de 2 façons :
Commentaire pour une ligne :// (deux barres obliques collés)
Commentaire pour plusieurs lignes : /* */ (barre oblique étoile pour le début du commentaire, puis étoile barre oblique pour la fin)
Il peut être inséré n’importe où dans la page, avant ou après une instruction et au-dessus ou au-dessous.
Voici un exemple de commentaire JavaScript :
Pour conclure, le code Javascript est interprété par le navigateur, mais sera également potentiellement lu par d’autres développeurs ou par vous-même dans quelques temps. Il est donc crucial d’expliquer certaine partie du code complexe ou non afin de comprendre plus rapidement sur son utilité en y intégrant des commentaires.
Ils sont d’ailleurs quasiment obligatoire pour un travail de groupe.