Commentaire Javascript

| | | | | | | | | | | | | | | | | | | |

Les commentaires JavaScript sont utilisés pour écrire des notes dans le code ou pour désactiver des sections de code sans les supprimer. Les commentaires se font en JavaScript en ajoutant // avant une seule ligne ou / * avant et * / après plusieurs lignes.

Commenter sur Le code est une caractéristique fondamentale de nombreux langages de programmation. L’idée derrière les commentaires de code est que même si votre code sera lu par l’ordinateur, votre code sera également lu par les humains, il est donc important qu’il soit facile pour les gens de comprendre le code que vous écrivez.

Les commentaires permettent vous permet de garder une trace de votre code pendant que vous programmez et vous donne la possibilité de prendre des notes qui peuvent être utiles à l’avenir. De plus, si vous travaillez en équipe, écrire des commentaires vous aidera à vous assurer que votre code est lisible pour toute personne susceptible de contribuer à votre travail.

Dans ce tutoriel, nous discuterons comment écrire des commentaires en JavaScript. Nous commencerons par discuter de la valeur des commentaires en JavaScript, puis examinerons la syntaxe que vous pouvez utiliser pour écrire des commentaires en JavaScript.

Écrire des commentaires sur le code

Commenter est une partie essentielle de l’écriture de code lisible et gérable. La vérité est que même si vous pouvez comprendre le code que vous écrivez aujourd’hui, rien ne garantit que vous serez en mesure de décrire efficacement ce qu’il fera demain. De plus, si vous travaillez avec d’autres personnes, il est très probable qu’elles ne comprennent pas une partie du code que vous écrivez.

C’est là que les commentaires entrent en jeu. Les commentaires sont des déclarations qui sont ignorées par le compilateur et peuvent être utilisées pour expliquer votre code JavaScript.

En tant que développeur, écrire des commentaires sur votre code vous permettra de suivre plus efficacement ce que vous faites . Au fur et à mesure que vous écrivez votre code, vous pouvez écrire des notes qui vous aideront à mieux comprendre votre code et à comprendre l’intention derrière le code que vous avez écrit plus tôt. √âcrire des commentaires sera également utile pour toute autre personne susceptible de voir votre code, car le commentaire les aidera probablement à comprendre plus en détail comment votre code fonctionne.

Chaque développeur écrit des commentaires différemment, mais la règle générale est que les commentaires doivent être utilisés pour expliquer l’intention derrière votre code. Après tout, votre code parle de lui-même, mais les raisons derrière l’écriture du code d’une certaine manière sont souvent pas. Ainsi, en écrivant des commentaires, vous pouvez expliquer pourquoi vous avez abordé un problème d’une certaine manière, ce qui permet à vous et aux autres de comprendre plus facilement le fonctionnement de votre programme plus tard.

Commentaires JavaScript

Il existe deux types de commentaires utilisés en JavaScript: les commentaires sur une seule ligne et les commentaires en bloc.

Les commentaires sur une seule ligne sont écrits à l’aide de deux barres obliques ( //) et sont écrits sur une seule ligne de code. Tout caractère suivant l’ instruction "//" sera ignoré jusqu’à la fin de la ligne. Voici un exemple de commentaire sur une seule ligne en JavaScript:

// Ceci est un commentaire sur une seule ligne

les blocs sont écrits avec des balises d’ouverture et de fermeture et vous permettent d’écrire des commentaires qui s’étendent sur plusieurs lignes. Les balises d’ouverture et de fermeture des commentaires de bloc sont:

  • "/ *" pour ouvrir un commentaire
  • "* /‚" pour fermer un commentaire

Les commentaires en bloc sont parfois appelés commentaires multilignes et ressemblent à des commentaires CSS multilignes. Voici un exemple de bloc de commentaire en JavaScript:

Tout le code entre nos balises d’ouverture et de fermeture sera ignoré par le compilateur.

Tout type de commentaire peut être utilisé pour expliquer votre code et discuter de l’intention derrière votre code. Voici un exemple de commentaire utilisé pour expliquer une déclaration de variable de base:

// Déclare la variable "chocolate" pour stocker les types de chocolat sous forme de tableau

var chocolate = [’Dark’, ’Milk’, ’White’, ’Hazelnut’, ’Caramel’] ;

Les commentaires dans n’importe quel langage de programmation doivent être mis à jour fréquemment à mesure que le code change . Ainsi, si nous décidions que notre nom de variable serait renommé en " types_chocolat ", nous devions mettre à jour notre commentaire pour nous assurer qu’il reflète le nouveau nom de variable. En fait, à mesure que les programmes grossissent, ils changent souvent de manière significative, il est donc important de mettre à jour les commentaires avec le code.

Commenter le code

Les commentaires sont souvent utilisés à deux fins. La première, comme nous l’avons vu dans cet article, est d’expliquer l’intention derrière votre code et de dissiper toute confusion . La deuxième consiste à empêcher l’exécution de code pendant les tests.

Les commentaires de code vous permettent d’interrompre l’exécution d’une ligne ou de plusieurs lignes de code sans supprimer complètement le code du programme. Les commentaires sont courants lors du débogage. , car vous pouvez essayer plusieurs solutions à un problème et conserver le code pour plus tard.

Voici un exemple de commentaire commentant une ligne de code:

Lorsque nous exécutons notre programme, le compilateur n’exécutera que la ligne de code qui déclare la variable "chocolat". Nous avons commenté le "flavors" car il contient une erreur et nous devons déboguer le problème. Dans ce cas, nous avons oublié de mettre un signe égal entre notre nom de variable ("saveurs") et la valeur de la variable (notre tableau de saveurs).

Voyons décomposez chacun des deux types de commentaires dont nous avons discuté et explorez comment ils peuvent être utilisés.

Commentaires sur une seule ligne

Commentaires sur une seule ligne, également appelés commentaires en ligne, sont utilisés pour commenter une partie d’une ligne de code ou une ligne entière de code. Voici un exemple de commentaire JavaScript d’une seule ligne:

Dans ce commentaire, nous déclarons une variable "first_type" qui stocke la première valeur dans notre tableau "chocolat". Ensuite, ajoutons un commentaire en ligne à la fin de notre ligne pour expliquer l’intention derrière notre code.

Les commentaires d’une seule ligne sont généralement utilisés pour faire de brefs commentaires sur votre code ou pour décrire l’intention derrière une ligne de code spécifique. Cependant, les commentaires sur une seule ligne ne sont pas le seul type de commentaire que vous devriez utiliser. Si vous avez besoin d’expliquer une fonction plus importante, il est préférable d’écrire des commentaires de bloc.

< / a>

Commentaires en masse

Les commentaires en masse sont écrits sur plusieurs lignes et sont utilisés pour expliquer une plus grande section de code. Alors que les commentaires d’une seule ligne expliquent généralement une ligne de code, un bloc commentaire peut expliquer une fonction ou le but d’un fichier.

Les commentaires multilignes commencent au début d’une fonction ou d’un fichier, dans la plupart Voici un exemple de commentaire de bloc utilisé pour expliquer un boucle for:

Notre commentaire de bloc s’étend à t lignes re et est utilisé pour décrire le code écrit dix dans notre boucle "for" .

Les commentaires de bloc peuvent également être trouvés au début d’un fichier pour expliquer le but d’un fichier ou pour inclure des informations sur l’auteur et la version du fichier. Voici un exemple d’extrait qui inclut l’auteur d’un fichier et la date à laquelle il a été créé en JavaScript:

Conclusion

√âcrire des commentaires sur le code permet d’écrire dans un format plus lisible et code maintenable. Vous pouvez utiliser des commentaires à la fois pour garder une trace de votre code pour vous-même à l’avenir et pour permettre aux autres personnes travaillant avec votre code de mieux comprendre son objectif.

Dans ce didacticiel, nous avons discuté des bases des commentaires, puis exploré comment écrire un commentaire en JavaScript. Nous avons également discuté des deux principaux types de commentaires - une ligne et plusieurs lignes - et avons montré des exemples de chaque type de commentaire de code en action. Enfin, nous avons discuté des différences entre commenter et commenter du code.

Vous êtes maintenant prêt à écrire des commentaires JavaScript comme un expert !