Commentaires JavaScript
Les commentaires JavaScript peuvent être utilisés pour expliquer le code JavaScript et pour le rendre plus lisible.
Les commentaires JavaScript peuvent également être utilisés pour empêcher l'exécution, lors du test de code alternatif.
Commentaires sur une seule ligne
Les commentaires sur une seule ligne commencent par //
.
Tout texte entre //
et la fin de la ligne sera ignoré par JavaScript (ne sera pas exécuté).
Cet exemple utilise un commentaire sur une seule ligne avant chaque ligne de code :
Exemple
// Change heading:
document.getElementById("myH").innerHTML = "My First Page";
// Change paragraph:
document.getElementById("myP").innerHTML = "My first paragraph.";
Cet exemple utilise un commentaire sur une seule ligne à la fin de chaque ligne pour expliquer le code :
Exemple
let x = 5; // Declare x, give it the value of 5
let y = x + 2; // Declare y, give it the value of x + 2
Commentaires multi-lignes
Les commentaires multi-lignes commencent par /*
et se terminent par */
.
Tout texte entre /*
et */
sera ignoré par JavaScript.
Cet exemple utilise un commentaire multiligne (un bloc de commentaire) pour expliquer le code :
Exemple
/*
The code below will change
the heading with id = "myH"
and the paragraph with id = "myP"
in my web page:
*/
document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
Il est plus courant d'utiliser des commentaires sur une seule ligne.
Les blocs de commentaires sont souvent utilisés pour la documentation formelle.
Utiliser des commentaires pour empêcher l'exécution
L'utilisation de commentaires pour empêcher l'exécution de code convient aux tests de code.
L'ajout //
devant une ligne de code change les lignes de code d'une ligne exécutable en commentaire.
Cet exemple utilise // pour empêcher l'exécution de l'une des lignes de code :
Exemple
//document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
Cet exemple utilise un bloc de commentaires pour empêcher l'exécution de plusieurs lignes :
Exemple
/*
document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
*/