Dans ce didacticiel, vous découvrirez les commentaires JavaScript, pourquoi vous devriez les utiliser et comment les utiliser à l'aide d'exemples.
Les commentaires JavaScript sont des indices qu'un programmeur peut ajouter pour rendre son code plus facile à lire et à comprendre. Ils sont complètement ignorés par les moteurs JavaScript.
Il existe deux façons d'ajouter des commentaires au code:
//- Commentaires sur une seule ligne/* */-Commentaires sur plusieurs lignes
Commentaires sur une seule ligne
En JavaScript, toute ligne commençant par //est un commentaire d'une seule ligne. Par exemple,
name = "Jack"; // printing name on the console console.log("Hello " + name);
Voici // printing name on the consoleun commentaire.
Vous pouvez également utiliser un commentaire sur une seule ligne comme celui-ci:
name = "Jack"; console.log("Hello " + name); // printing name on the console
Commentaires sur plusieurs lignes
En Javascript, tout texte entre /*et */est un commentaire sur plusieurs lignes. Par exemple,
/* The following program contains the source code for a game called Baghchal. Baghchal is a popular board game in Nepal where two players choose either sheep or tiger. It is played on a 5x5 grid. For the player controlling the tiger to win, they must capture all the sheep. There are altogether 4 tigers on the board. For the sheep to win, all tigers must be surrounded and cornered so that they cannot move. The player controlling the sheep has 20 sheep at his disposal. */
Puisque le reste du code source sera utilisé pour implémenter les règles du jeu, le commentaire ci-dessus est un bon exemple où vous pouvez utiliser un commentaire multiligne.
Utilisation des commentaires pour le débogage
Les commentaires peuvent également être utilisés pour désactiver le code afin d'empêcher son exécution. Par exemple,
console.log("some code"); console.log("Error code); console.log("other code");
Si vous obtenez une erreur lors de l'exécution du programme, au lieu de supprimer le code sujet aux erreurs, vous pouvez utiliser des commentaires pour empêcher son exécution; cela peut être un outil de débogage précieux.
console.log("some code"); // console.log("Error code); console.log("other code");
Astuce de pro: souvenez-vous du raccourci pour utiliser les commentaires; cela peut être vraiment utile. Pour la plupart des éditeurs de code, c'est Ctrl + /pour Windows et Cmd + /pour Mac.
Rendre le code plus facile à comprendre
En tant que développeur JavaScript, vous n'écrirez pas seulement du code, mais vous devrez peut-être également modifier le code écrit par d'autres développeurs.
Si vous écrivez des commentaires sur votre code, il vous sera plus facile de comprendre le code à l'avenir. De plus, il sera plus facile pour vos collègues développeurs de comprendre le code.
En règle générale, utilisez des commentaires pour expliquer pourquoi vous avez fait quelque chose plutôt que comment vous avez fait quelque chose, et vous êtes bon.
Remarque: les commentaires ne doivent pas remplacer un moyen d'expliquer un code mal écrit en anglais. Vous devez toujours rédiger un code bien structuré et explicite. Et puis utilisez des commentaires.
