Le langage JavaScript supporte deux formats de remarque. Le premier format aux syntaxes suivantes :
| /* ma remarque */ |
ou
|
/* ma remarque étalée sur plusieurs lignes ... */ |
Comme la seconde syntaxe le démontre, on peut étirer les commentaires sur plusieurs lignes ou simplement la mettre sur une ligne, le JavaScript n'y voit aucune différence.
Le deuxième n'affecte que la ligne courante du code source. Donc, lorsqu'on se retrouve à la ligne suivante, les instructions régulières reprennent et la remarque n'a plus court. Finalement, son format à la syntaxe suivante :
| // ma remarque |
Remarque
- L'utilisation abusive des commentaires dans le code JavaScript peut certes aider la compréhension du code source toutefois il nuira au statistiques SEO, car plus la page a un volume important d'octets, plus cela nui à l'expérience utilisateur. Ainsi, il faudra mettre uniquement des informations de droits d'auteurs sans explications dans un code ayant un accès publique. Naturellement, cette règle ne s'applique pas dans un contexte d'Intranet ou dans un réseau nécessitant une authentification utilisateur.
Exemple
Voici un exemple typique de l'utilisation de cette fonction :
Dernière mise à jour : Dimanche, le 12 janvier 2014