Commentaires en JavaScript

• Mai 1, 2024

Les commentaires ne sont que des commentaires que vous mettez dans votre JavaScript ou HTML pour expliquer ce qui se passe. Il existe plusieurs façons de mettre des commentaires dans votre code JavaScript. La syntaxe des commentaires - comment dire au script ou au document que quelque chose est un commentaire et non des données ou du code - est très simple. Écrire de bons commentaires est plus difficile, et en regardant le code (le mien inclus), la partie la plus difficile semble être de le faire!

JavaScript a 2 types de commentaires, un commentaire sur une seule ligne et un commentaire sur plusieurs lignes.

Le commentaire sur une seule ligne en JavaScript commence par deux barres obliques (//) et se termine à la fin de la ligne (techniquement, immédiatement avant le caractère de fin de ligne). Les commentaires sur une seule ligne sont particulièrement utiles pour les notes courtes.

// Ceci est un commentaire sur une seule ligne
data = "mes données" // Ceci est aussi un commentaire sur une seule ligne

Un commentaire sur plusieurs lignes en JavaScript commence par une barre oblique suivie d'un astérisque (/*) et se termine par un astérisque suivi d'une barre oblique (*/). Tout entre le /* et */ est considéré comme un commentaire. Ce type de commentaire peut s'étendre sur plusieurs lignes. Il est également possible de placer ce type de commentaire au milieu d'une ligne de code, s'il ne s'étend pas sur plusieurs lignes, mais cela est rarement utile.

/ * il s'agit de la première ligne d'un commentaire sur plusieurs lignes
cela fait toujours partie de mon commentaire
c'est la dernière partie de mon commentaire * /

/ * ceci est un commentaire de style multi-lignes sur une seule ligne * /

Vous voyez souvent des astérisques supplémentaires ajoutés aux commentaires sur plusieurs lignes pour créer des boîtes d'informations décoratives, telles que:

/*********************
* Mes fonctions *
*********************/

Les fonctions multilignes sont particulièrement utiles au début d'un programme ou d'une section d'un programme pour décrire ce que le programme est censé faire et comment il le fait.

Les commentaires sont utilisés à deux fins. Lorsque vous écrivez du code (ou même avant de l'écrire!), Vous devez écrire des commentaires qui permettront à une autre personne de comprendre ce que le programme fait (ou est censé faire). Même si vous ne vous attendez à ce que personne d'autre ne lise jamais votre code, vous serez surpris de ce que vous pouvez oublier si vous souhaitez apporter des modifications après quelques semaines ou mois.

De plus, en particulier dans les langages de script comme JavaScript, les commentaires sont souvent utilisés dans le cadre du processus de débogage. Vous pouvez mettre du code à utiliser pour le débogage et les commenter lorsque vous avez fini de les utiliser ou commenter des sections de code qui, selon vous, posent problème ou changent pour ajouter de nouvelles fonctionnalités. Lorsque vous faites cela, faites particulièrement attention à ne pas mettre un commentaire d'une seule ligne sur la ligne devant le début d'un commentaire sur plusieurs lignes. Cela décommente le reste du commentaire sur plusieurs lignes, ce qui provoquera presque certainement une erreur.

Instructions Vidéo: Tutoriel Javascript : Les commentaires #1 (Mai 2024).