Commentaires JScript
Mise à jour : novembre 2007
Un commentaire JScript d'une seule ligne commence par deux barres obliques (//).
Commentaires dans le code
Voici un exemple de commentaire d'une seule ligne, suivi d'une ligne de code.
// This is a single-line comment.
aGoodIdea = "Comment your code for clarity.";
Un commentaire JScript multiligne commence par une barre oblique suivie d'un astérisque (/*) et se termine par un astérisque suivi d'une barre oblique (*/).
/*
This is a multiline comment that explains the preceding code statement.
The statement assigns a value to the aGoodIdea variable. The value,
which is contained between the quote marks, is called a literal. A
literal explicitly and directly contains information; it does not
refer to the information indirectly. The quote marks are not part
of the literal.
*/
Si vous tentez d'incorporer un commentaire multiligne dans un autre, JScript interprète le commentaire multiligne obtenu de manière inattendue. Le symbole */ qui marque la fin d'un commentaire multiligne incorporé est interprété comme la fin de tout le commentaire multiligne. En conséquence, le texte qui suit le commentaire multiligne incorporé est interprété comme du code JScript et peut générer des erreurs de syntaxe.
Dans l'exemple ci-dessous, la troisième ligne de texte est interprétée comme du code JScript parce que JScript a interprété le symbole */ le plus profond comme la fin du commentaire le plus externe :
/* This is the outer-most comment
/* And this is the inner-most comment */
...Unfortunately, JScript will try to treat all of this as code. */
Il est conseillé d'écrire tous les commentaires sous la forme de blocs de commentaires d'une seule ligne. Ainsi, vous pourrez, par la suite, transformer en commentaire d'importants segments de code avec un seul commentaire multiligne.
// This is another multiline comment, written as a series of single-line comments.
// After the statement is executed, you can refer to the content of the aGoodIdea
// variable by using its name, as in the next statement, in which a string literal is
// appended to the aGoodIdea variable by concatenation to create a new variable.
var extendedIdea = aGoodIdea + " You never know when you'll have to figure out what it does.";
Par ailleurs, vous pouvez utiliser la compilation conditionnelle pour transformer en commentaire d'importants segments de code de façon efficace.