Vous êtes ici Tutoriel Les Commentaires

Lien utile

Tutoriel sur le JavaScript - Les Commentaires

Tous niveaux


Tutoriel écrit par LaurentG alias KOogar le 31 Mars 2009


Avez-vous déjà écrit un script ou un programme dans le passé, puis six mois plus tard l’avoir consulté, sans aucune idée de ce qui se passe dans le code? Vous avez probablement oublié de faire ce que tous les programmeurs ont tendance à oublier de faire: écrire des commentaires!
Lors de l'écriture d’un code, vous faites appel à une logique complexe qui peut prêter à confusion. Voici une excellente occasion d'inclure des commentaires dans le code qui vous expliqueront ce qui s’y passe. Non seulement cela peut vous aider à vous le rappeler plus tard, et si quelqu'un d'autre étudie votre code, cela lui permettra de le comprendre!
Une autre grande chose au sujet des commentaires est leur capacité à supprimer des portions de code. Il existe 2 types de commentaires en JavaScript: les commentaires uniligne et les commentaires multi lignes.


Sommaire :




Les Commentaires



La Création de Commentaires Uniligne

Pour créer une seule ligne de commentaire en JavaScript, vous placez deux barres obliques "/ /" devant le code ou le texte que vous souhaitez faire ignorer par l'interpréteur JavaScript. Lorsque vous placez ces deux barres, l'ensemble du texte à la droite de celles-ci sera ignoré, jusqu'à la ligne suivante.

Ce type de commentaire est parfait pour désactiver des codes uniligne et écrire de petites notes.

.01
.02
.03
.04
.05
.06
.07
.08
.09
  <script type="text/javascript">
<!--
// ceci est une simple ligne de commentaire

document.write("Il y a des commentaires dans mon code JS!");
//document.write("Vous ne pouvez pas le voir");
//-->
</script>

La Création de Commentaires Multi ligne

Bien qu’un commentaire uniligne soit tout à fait utile, il peut parfois être lourd à utiliser lors de la désactivation de longs segments de code ou de l'insertion de commentaires tirant en longueur. Pour de long commentaires, vous pouvez utiliser le commentaire multi lignes de JavaScript qui commence par /* et se termine par */.
.01
.02
.03
.04
.05
.06
.07
.08
.09
.10
.11
.12
.13
  <script type="text/javascript">
<!--
document.write("Je fais des commentaires multi lignes!");
/* document.write("Vous ne pouvez pas le voir");
document.write("Vous ne pouvez pas le voir");
document.write("Vous ne pouvez pas le voir");
document.write("Vous ne pouvez pas le voir");
document.write("Vous ne pouvez pas le voir");
document.write("Vous ne pouvez pas le voir");
document.write("Vous ne pouvez pas le voir");*/
//-->
</script>
Affiche: "Je fais des commentaires multi lignes!"

Très souvent, les éditeurs de texte ont la possibilité de désactiver de nombreuses lignes de code en frappant une touche ou à partir des options dans le menu. Si vous utilisez un éditeur de texte spécialisé pour la programmation, assurez-vous qu’il possède une option pour désactiver facilement plusieurs lignes de code!