Notice: This page requires JavaScript to function properly.
Please enable JavaScript in your browser settings or update your browser.
Apprendre Utilisation des Commentaires pour Documenter le Code | Fondamentaux de JavaScript
Introduction à JavaScript

bookUtilisation des Commentaires pour Documenter le Code

Parfois, il peut être nécessaire d'empêcher l'exécution d'une partie spécifique de votre code. Supprimer entièrement le code n'est pas pratique si vous souhaitez tester une autre section ultérieurement. Divers scénarios peuvent nécessiter l'arrêt temporaire de l'exécution d'une partie non fonctionnelle de votre code. Dans ces situations, les commentaires sont particulièrement utiles.

Remarque

Les commentaires offrent une syntaxe permettant de masquer certaines sections de votre code à l'interpréteur ou au compilateur. Ils sont également précieux pour la documentation du code à destination d'autres développeurs.

Commentaires sur une seule ligne

Les commentaires sur une seule ligne bloquent toute la ligne de code, garantissant que le code situé au-dessus et en dessous est exécuté. La syntaxe des commentaires sur une seule ligne est simple : il suffit d'ajouter // avant le code de la ligne que vous souhaitez commenter :

123
console.log("Line 1"); // console.log("Line 2"); console.log("Line 3");
copy

L'exemple ci-dessus montre que le commentaire // bloque la deuxième ligne de code, qui n'est pas exécutée.

Nous pouvons également utiliser des commentaires sur une seule ligne pour bloquer plusieurs lignes de code consécutives :

12345
console.log("Line 1"); console.log("Line 2"); // console.log("Line 3"); // console.log("Line 4"); console.log("Line 5");
copy

Nous pouvons également ajouter le commentaire à la fin de la ligne.

123
console.log("Part 1.1"); console.log("Part 1.2"); console.log("Part 2.1"); // console.log("Part 2.2") console.log("Part 3.1"); console.log("Part 3.2");
copy

Commentaires multi-lignes

Considérer une situation avec un bloc de code volumineux, de 299 lignes. Commenter chaque ligne individuellement serait chronophage. C'est là que les commentaires multi-lignes sont utiles.

Les commentaires multi-lignes commencent par /* et se terminent par */. Tout code inclus entre ces symboles est mis en commentaire :

1234567891011
console.log("Line 1"); console.log("Line 2"); /* console.log("Line 4"); console.log("Line 5"); console.log("Line 6"); console.log("Line 7"); console.log("Line 8"); console.log("Line 9"); */ console.log("Line 11");
copy

Dans l'exemple ci-dessus, on peut voir que les lignes de code de 3 à 10 n'ont pas été exécutées.

Il est possible d'utiliser des commentaires multi-lignes pour commenter une partie de la ligne :

1
console.log("Part 1", /* "Part 2", */ "Part 3");
copy
1
/* console.log("Part 1"); */ console.log("Part 2");
copy

1. Pourquoi utilise-t-on des commentaires dans le code ?

2. Comment créer un commentaire sur une seule ligne ?

3. Quelle est la syntaxe pour créer un commentaire sur plusieurs lignes ?

4. Si vous avez un grand bloc de code et que vous l'entourez avec /* et */, que se passe-t-il pour le code inclus ?

question mark

Pourquoi utilise-t-on des commentaires dans le code ?

Select the correct answer

question mark

Comment créer un commentaire sur une seule ligne ?

Select the correct answer

question mark

Quelle est la syntaxe pour créer un commentaire sur plusieurs lignes ?

Select the correct answer

question mark

Si vous avez un grand bloc de code et que vous l'entourez avec /* et */, que se passe-t-il pour le code inclus ?

Select the correct answer

Tout était clair ?

Comment pouvons-nous l'améliorer ?

Merci pour vos commentaires !

Section 1. Chapitre 4

Demandez à l'IA

expand

Demandez à l'IA

ChatGPT

Posez n'importe quelle question ou essayez l'une des questions suggérées pour commencer notre discussion

Suggested prompts:

Can you explain the difference between single-line and multi-line comments?

When should I use single-line comments versus multi-line comments?

Are there any best practices for using comments in JavaScript?

Awesome!

Completion rate improved to 2.33

bookUtilisation des Commentaires pour Documenter le Code

Glissez pour afficher le menu

Parfois, il peut être nécessaire d'empêcher l'exécution d'une partie spécifique de votre code. Supprimer entièrement le code n'est pas pratique si vous souhaitez tester une autre section ultérieurement. Divers scénarios peuvent nécessiter l'arrêt temporaire de l'exécution d'une partie non fonctionnelle de votre code. Dans ces situations, les commentaires sont particulièrement utiles.

Remarque

Les commentaires offrent une syntaxe permettant de masquer certaines sections de votre code à l'interpréteur ou au compilateur. Ils sont également précieux pour la documentation du code à destination d'autres développeurs.

Commentaires sur une seule ligne

Les commentaires sur une seule ligne bloquent toute la ligne de code, garantissant que le code situé au-dessus et en dessous est exécuté. La syntaxe des commentaires sur une seule ligne est simple : il suffit d'ajouter // avant le code de la ligne que vous souhaitez commenter :

123
console.log("Line 1"); // console.log("Line 2"); console.log("Line 3");
copy

L'exemple ci-dessus montre que le commentaire // bloque la deuxième ligne de code, qui n'est pas exécutée.

Nous pouvons également utiliser des commentaires sur une seule ligne pour bloquer plusieurs lignes de code consécutives :

12345
console.log("Line 1"); console.log("Line 2"); // console.log("Line 3"); // console.log("Line 4"); console.log("Line 5");
copy

Nous pouvons également ajouter le commentaire à la fin de la ligne.

123
console.log("Part 1.1"); console.log("Part 1.2"); console.log("Part 2.1"); // console.log("Part 2.2") console.log("Part 3.1"); console.log("Part 3.2");
copy

Commentaires multi-lignes

Considérer une situation avec un bloc de code volumineux, de 299 lignes. Commenter chaque ligne individuellement serait chronophage. C'est là que les commentaires multi-lignes sont utiles.

Les commentaires multi-lignes commencent par /* et se terminent par */. Tout code inclus entre ces symboles est mis en commentaire :

1234567891011
console.log("Line 1"); console.log("Line 2"); /* console.log("Line 4"); console.log("Line 5"); console.log("Line 6"); console.log("Line 7"); console.log("Line 8"); console.log("Line 9"); */ console.log("Line 11");
copy

Dans l'exemple ci-dessus, on peut voir que les lignes de code de 3 à 10 n'ont pas été exécutées.

Il est possible d'utiliser des commentaires multi-lignes pour commenter une partie de la ligne :

1
console.log("Part 1", /* "Part 2", */ "Part 3");
copy
1
/* console.log("Part 1"); */ console.log("Part 2");
copy

1. Pourquoi utilise-t-on des commentaires dans le code ?

2. Comment créer un commentaire sur une seule ligne ?

3. Quelle est la syntaxe pour créer un commentaire sur plusieurs lignes ?

4. Si vous avez un grand bloc de code et que vous l'entourez avec /* et */, que se passe-t-il pour le code inclus ?

question mark

Pourquoi utilise-t-on des commentaires dans le code ?

Select the correct answer

question mark

Comment créer un commentaire sur une seule ligne ?

Select the correct answer

question mark

Quelle est la syntaxe pour créer un commentaire sur plusieurs lignes ?

Select the correct answer

question mark

Si vous avez un grand bloc de code et que vous l'entourez avec /* et */, que se passe-t-il pour le code inclus ?

Select the correct answer

Tout était clair ?

Comment pouvons-nous l'améliorer ?

Merci pour vos commentaires !

Section 1. Chapitre 4
some-alt