Самая простая и самая значимая шпаргалка. В самом начале стоит заметить, что комментарии нужны только для человека (то есть программиста). Компьютер их не то, что не читает, он их вообще игнорирует, а следовательно, в них можно писать все что душе угодно. Однако, чаще их используют для решения двух основных задач:

• Внесение “человеческих” пояснений в код, чтобы другие разработчики легче разобрались что к чему.
• Деактивация блоков кода. Вместо того, чтобы удалять код, который был написан, но не используется в данный момент, его можно закомментировать.

Оформление комментариев.

Стандартно комментарий оформляется как две косые черты. При таком обозначении транслятор проигнорирует все, что написано с правой стороны от них. Пример:

var x=5; // Начиная с // и до конца строки игнорируется транслятором
var rc=123; // Переменная, обозначающая радиус (radius) круга (circle)

Продвинутая версия многострочного комментария обозначается как косая черта и звездочка с одной стороны и звездочка с идущей за ней косой чертой с другой стороны. Все что между этих специфических “скобок” будет игнорироваться транслятором. Пример:

function foo(foovar) {
    /* Здесь происходят магические преобразования переменной foovar без использования бубна и барабана.*/
}

Подводные камни и полезные советы.

Стоит помнить, что внутри кода JavaScript (а также внутри комментариев JavaScript, так как они являются частью кода) не рекомендуется использовать тэг </script>. Проблема заключается в том, что при встрече браузером такого тэга, он подумает, что блок кода закончился и станет интерпретировать весь последующий текст как HTML код, что нам крайне нежелательно. Пример:

var x=5;
/* Браузер перестанет воспринимать текст как код JavaScript сразу, как встретит тэг </script>. Начиная с этих слов, все появится на экране как простой текст. Чтобы избежать этого, используйте конкатенацию строк, как показано ниже: */
document.writeln('</scr'+'ipt>');

Комментарии в коде полезны для программиста, но совершенно лишние для посетителя сайта. Мало того, что он их читать не будет (возможно ему и не следует вникать в суть кода в целях обеспечения безопасности сервера и защиты от хакеров), комментарии будут увеличивать объем исходных файлов страниц, закачиваемых через интернет. Получается, что чем больше комментариев, тем дольше загружается страница.

Рекомендуется хранить две версии кода сайта: одна для публикации без комментариев, другая для разработки с комментариями.

Легко заметить, что размер файла увеличивают и пробелы, и многочисленные переносы строк для удобочитаемости, и другие “издержки производства”, которые никак не влияют на функциональную часть. Было бы здорово их тоже удалить из публичной версии файла. На этой случай я могу предложить две полезные ссылки:

• http://www.crockford.com/javascript/jsmin.html - приложение для сжатия кода JavaScript;
• http://fmarcia.info/jsmin/test.html - онлайн сервис по сжатию кода JavaScript.

Итог.

Как заметно из статьи, комментарии могут как облегчить жизнь и учесть программиста, так и, наоборот, усложнить. Но все же, пренебрегать ими не стоит.