Commentaires JavaScript

Les commentaires JavaScript sont utilisés pour ajouter des notes explicatives à votre code, le rendant plus compréhensible pour vous-même et pour les autres.

Les commentaires sont ignorés par le moteur JavaScript et n’affectent pas l’exécution du programme. Ils peuvent également être utilisés pour désactiver temporairement des lignes de code à des fins de test.

Commentaires sur une seule ligne

Les commentaires sur une seule ligne commencent par //.

Tout texte de // jusqu’à la fin de la ligne actuelle est traité comme un commentaire et sera ignoré par JavaScript.

Exemple : Utilisation de commentaires sur une seule ligne pour expliquer le code :

// Sélectionne l'élément de titre et modifie son contenu textuel
const myHeading = document.getElementById("myH");
myHeading.textContent = "My Updated Page Title";

// Sélectionne l'élément de paragraphe et met à jour son contenu
const myParagraph = document.getElementById("myP");
myParagraph.textContent = "This is my updated first paragraph.";

Exemple : Utilisation de commentaires sur une seule ligne à la fin des lignes :

let x = 5;      // Déclare la variable x et lui affecte la valeur 5
let y = x + 2;  // Déclare la variable y et lui affecte la valeur de x + 2 (qui est 7)

Commentaires multi-lignes

Les commentaires multi-lignes commencent par /* et se terminent par */.

Tout texte entre /* et */ sera ignoré par JavaScript, quelle que soit le nombre de lignes qu’il occupe.

Exemple : Utilisation d’un commentaire multi-lignes (un bloc de commentaires) pour expliquer une section de code :

/*
Le bloc de code suivant effectue deux actions :
1. Il récupère l'élément HTML avec l'ID 'myH' et met à jour son contenu.
2. Il récupère l'élément HTML avec l'ID 'myP' et met à jour son contenu.
Ceci est utile pour des explications plus détaillées.
*/
document.getElementById("myH").innerHTML = "My First Page Revisted";
document.getElementById("myP").innerHTML = "My first paragraph, updated again.";

Bien que les deux types de commentaires soient utiles, les commentaires sur une seule ligne (//) sont souvent préférés pour des explications rapides et concises, tandis que les commentaires multi-lignes (/* ... */) sont bons pour des descriptions plus longues ou pour désactiver temporairement des blocs de code plus importants. Les commentaires JSDoc, qui utilisent une syntaxe /** ... */, sont une forme spéciale de commentaire multi-lignes utilisée pour générer de la documentation.

Utiliser les commentaires pour empêcher l’exécution (débogage)

Mettre du code en commentaire est une technique courante pendant le développement et le débogage pour empêcher temporairement l’exécution de certaines lignes ou blocs de code, sans les supprimer.

Exemple : Utilisation de // pour empêcher l’exécution d’une ligne :

// document.getElementById("myH").innerHTML = "Cette ligne est commentée." ;
document.getElementById("myP").innerHTML = "This paragraph will be updated.";

Exemple : Utilisation d’un commentaire multi-lignes pour empêcher l’exécution de plusieurs lignes :

/*
console.log("Ceci ne sera pas enregistré.");
const importantValue = 42;
if (importantValue > 10) {
    console.log("Ce bloc est également commenté.");
}
*/
console.log("This line will execute.");

Cela vous permet d’isoler des parties de votre code pour trouver des erreurs ou tester différentes approches.