Комментарии в JScript
Обновлен: Ноябрь 2007
Комментарий JScript, состоящий из одной строки, начинается с двух знаков косой черты (//).
Комментарии в коде
Вот пример однострочного комментария, за которым следует строка кода.
// This is a single-line comment.
aGoodIdea = "Comment your code for clarity.";
Комментарий JScript, состоящий из нескольких строк, начинается с косой черты и звездочки (/*), а заканчивается на эти же знаки, стоящие в обратном порядке (*/).
/*
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.
*/
При попытке вставить один многострочный комментарий внутрь другого результат будет обработан в JScript неожиданным образом. Знаки */, означающие конец внутреннего многострочного комментария, будут считаться концом всего многострочного комментария. Следующий за этими знаками текст будет обрабатываться как код JScript, что может привести к возникновению синтаксических ошибок.
В следующем примере третья строка текста интерпретируется как код JScript, поскольку внутренние знаки */ будут считаться концом всего комментария.
/* This is the outer-most comment
/* And this is the inner-most comment */
...Unfortunately, JScript will try to treat all of this as code. */
Рекомендуется писать все комментарии как блоки однострочных комментариев. Это позволяет переносить в комментарии крупные сегменты кода с помощью многострочных комментариев на более поздних этапах.
// 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.";
Также можно использовать условное компилирование, чтобы переносить в комментарии крупные сегменты кода.