Comment écrire des commentaires dans le code javascript

Les commentaires sont des notes qu'un programmeur laisse dans son code pour le rendre plus compréhensible. La plupart des développeurs seniors se concentrent sur l'écriture de code qui est efficace et peut être facilement lue et interprétée par les ordinateurs. Cependant, il est d'une égale importance de rendre le code facilement lisible pour les personnes (qui travaillera également avec le code à l'avenir). Un programmeur doit savoir correctement à structurer le code pour le rendre plus compréhensible pour les humains.

Que sont les commentaires?

Les commentaires peuvent être n'importe quoi, d'une seule explication de ligne à la description multi-ligne du code qui est écrite dans le code source d'un programme. Ils sont généralement utilisés pour laisser des notes dans les parties complexes du code source afin que quiconque regarde le code à l'avenir puisse facilement comprendre l'objectif de ce morceau de code. Cette pratique fait gagner du temps car n'importe qui peut facilement comprendre le but du code sans faire d'effort.

Commençons maintenant à apprendre à structurer correctement le code source JavaScript en écrivant différents types de commentaires:

Types de commentaires en javascript

JavaScript a deux principaux types de commentaires:

• Commentaires à une seule ligne.
• Commentaires multi-lignes

Commentaires en une seule ligne: Dans JavaScript, deux slashes avant (//) sont utilisés pour écrire des commentaires en une seule ligne:

// un commentaire à une seule ligne

Les commentaires dans tout langage de programmation n'ont aucun effet sur le programme réel. Les interprètes / compilateurs de langages de programmation sont conçus de manière à ignorer tous les commentaires lors de l'interprétation / compilation d'un programme.

Les commentaires peuvent avoir leurs propres lignes distinctes; Ils peuvent également être ajoutés en ligne avec un autre code.

Commentaires en ligne: Lorsque les commentaires en une seule ligne sont utilisés dans la même ligne que le code, ils sont appelés commentaires en ligne:

Soit a = 30; // un commentaire en ligne
Soit b = a + 10; // Ajout de 10 dans "A" variable et l'attribuant à "B"

Les commentaires en ligne sont utilisés pour expliquer la ligne de code exacte sur laquelle ils sont écrits; Ils peuvent être utilisés pour une petite description spécifique du code présent sur cette ligne.

Commentaires en plusieurs lignes: Dans JavaScript, les commentaires du bloc, les commentaires multi-lignes sont écrits de la même manière qu'ils sont écrits en CSS avec des balises d'ouverture (/ *) et des balises de fermeture (* /):

/* Un bloc
Commentaire*/

Tout le texte entre les balises d'ouverture et de clôture est ignoré par les interprètes.

Les commentaires multi-lignes ou les commentaires au niveau des blocs sont utilisés pour expliquer et donner une description détaillée d'une section de code. Ce type de commentaires est généralement placé en haut du fichier de code source ou avant un bloc de code particulièrement complexe:

/ * Récupérer le nom de l'utilisateur
à partir d'un champ d'entrée
et le montrant sur la console * /
fonction showUser ()
const name = document.getElementById ('utilisateur-nom');
console.Log ("Bonjour et bienvenue au Linuxhint.com, "+ name +".");

showUser ();

Commentant le code pour tester / débogage: Les commentaires peuvent être utilisés pour empêcher rapidement et facilement l'exécution d'un code de bloc; Tant de développeurs JavaScript seniors utilisent également des commentaires à des fins de test et de débogage. Placer les balises de commentaire derrière un bloc de code afin qu'elle soit ignorée par l'interprète et n'est pas exécutée est appelée «commentaire du code».

Commentaire le code aide à identifier la cause d'une erreur dans le code. Ils peuvent également être utilisés pour tester différents blocs de code pour obtenir des résultats différents:

// fonction pour diviser deux nombres
Division des fonctions (dividende, diviseur)
Soit quotiiment = dividende / diviseur;
Retour quotient;

// fonction pour soustraire deux nombres
Soustraction de la fonction (num1, num2)
Soit sub = num1 - num2;
retour sub;

/ * Dans la ligne de code suivante, nous commençons l'appel de la fonction de la fonction de division. Par conséquent, seule la fonction soustraction () sera appelée et exécutée. * /
// Division (30, 5);
MultiplyTwonumbers (9, 3);

Pratiques pour écrire un bon code JavaScript

Ici, nous discuterons des trois meilleures pratiques pour écrire un bon code JavaScript:

Les commentaires sont généralement écrits au-dessus du bloc de code qu'ils expliquent:

// montre "Bonjour, Linuxhint!"Sur la console
console.Log ("Bonjour, Linuxhint!");

Commentaires sur le lien au même niveau que le code immédiatement en dessous:

// Définition de la fonction
fonction showUser ()
// récupérer le nom d'utilisateur
const name = document.getElementById ('utilisateur-nom');
// imprime le message sur la console
console.Log ("Bonjour et bienvenue au Linuxhint.com, "+ name +".");

N'oubliez pas qu'il n'y a aucun moyen de mettre fin aux commentaires en ligne; Ils ne devraient donc être écrits qu'après que le code de cette ligne a été complètement écrit:

pour (soit i = 0; i === 10; i ++) // pour une boucle qui s'exécute dix fois
// L'exécution de ce code entraîne une erreur de syntaxe

Conclusion

Combien de fois avez-vous résolu un problème complexe en écrivant du code pour revenir quelques mois plus tard et découvrez que vous vous souvenez et ne comprenez rien? Les commentaires vous aident à éviter cela en écrivant des explications / descriptions détaillées de votre code. Ils aident également à déboguer les tests et à identifier la source des erreurs dans votre code. Les commentaires simples et multilines peuvent être utilisés à des fins de débogage / test. Si vous êtes un développeur JavaScript débutant, vous devez écrire autant de commentaires que possible dans votre code que nécessaire pour comprendre le code que vous écrivez; Mais rappelez-vous qu'ils ne devraient être ajoutés que là où ils sont nécessaires.