Со временем программа становится большой и сложной. Появляется необходимость добавить комментарии, которые объясняют, что происходит и почему.
Комментарии могут находиться в любом месте программы и никак не влияют на ее выполнение. Интерпретатор JavaScript попросту игнорирует их.
Однострочные комментарии начинаются с двойного слэша //. Текст считается комментарием до конца строки:
// Команда ниже говорит "Привет"
alert('Привет');
alert('Мир'); // Второе сообщение выводим отдельно
Многострочные комментарии начинаются слешем-звездочкой "/*" и заканчиваются звездочкой-слэшем "*/", вот так:
/* Пример с двумя сообщениями.
Это - многострочный комментарий.
*/
alert('Привет');
alert('Мир');
Все содержимое комментария игнорируется. Если поместить код внутрь /* ... */ или после // — он не выполнится.
/* Закомментировали код
alert('Привет');
*/
alert('Мир');
Вложенные комментарии не поддерживаются!
В этом коде будет ошибка:
/*
alert('Привет'); /* вложенный комментарий ?!? */
*/
alert('Мир');
В многострочных комментариях всё очень просто — комментарий длится от открытия /* до закрытия */. Таким образом, код выше будет интерпретирован так:
Комментарий открывается /* и закрывается */:
/*
alert('Привет'); /* вложенный комментарий ?!? */
Код (лишние символы сверху вызывают ошибку):
*/
alert('Мир');
Виды комментариев
Существует три типа комментариев.
1. Первый тип отвечает на вопрос «Что делает эта часть кода?».
Эти комментарии бывают особенно полезны, если используются неочевидные алгоритмы.
2. Второй тип комментариев отвечает на вопрос «Почему я выбрал этот вариант решения задачи?». И он гораздо важнее.
При создании кода мы принимаем много решений, выбираем лучший вариант из нескольких возможных. Иногда для правильного выбора нужно многое изучить, посмотреть.
Когда вы остановились на чём-то — не выбрасывайте проделанную работу, укажите, хотя бы кратко, что вы посмотрели и почему остановились именно на этом варианте.
Особенно это важно, если выбранный вариант не очевиден, а существует другое, более очевидное, но неправильное решение. Ведь в будущем, вернувшись к этому коду, мы можем захотеть переписать «сложное» решение на более «явное» или «оптимальное», тут-то и комментарий и поможет понять, что к чему.
Например: «Я выбрал здесь анимацию при помощи JavaScript вместо CSS, поскольку IE именно в этом месте ведёт себя некорректно».
3. Третий тип комментариев возникает, когда мы в одном месте кода делаем вычисления или присвоения переменных, неочевидным образом использованные совсем в другом месте кода.
Например: «Эти значения отформатированы именно так, чтобы их можно было передать на сервер».
Не бойтесь комментариев. Чем больше кода в проекте — тем они важнее. Что же касается увеличения размера кода — это не страшно, т.к. существуют инструменты сжатия JavaScript, которые при публикации кода легко их удалят.
На следующих занятиях мы поговорим о переменных, блоках и других структурных элементах программы на JavaScript.
Переменные
1. Переменная
1. Аналогия из жизни
2. Копирование значений
2. Важность директивы var
3. Константы
В зависимости от того, для чего вы делаете скрипт, понадобится работать с информацией.
Если это электронный магазин - то это товары, корзина. Если чат - посетители, сообщения и так далее.
Чтобы хранить информацию, используются переменные.