Блог Vaden Pro

Все о самостоятельном создании и продвижении сайтов

Команды и комментарии в js

Дата:18.02.15 в 14:25
Раздел: 

Как задаются команды в javascript?

Давайте рассмотрим синтаксис команд в javascript на простейшем примере:

alert('Сообщение 1'); alert('Сообщение 2');

Таким образом мы 2 раза вызываем команду alert. Рассмотрим запись подробнее:

  1. Разделителем команд в js является точка с запятой.
  2. Для большей читабельности кода принято писать новую команду с новой строки, тобишь стилистически верной будет запись:
    alert('Сообщение 1'); 
    alert('Сообщение 2');
  3. Помимо точки с запятой интерпретатор обрабатывает как разделитель команд переход на новую строку.
    alert('Сообщение 1')
    alert('Сообщение 2')
    Такая запись также верно сработает и дважды вызовет alert. Существенным недостатком данного метода записи является то, что JavaScript далеко не всегда «вставляет виртульный разделитель команд» так, как нужно. Это бывает крайне редко, но случается и ошибки в исполнении скрипта в этом случае исправить крайне сложно. Потому стандартом на сегодняшний день в записи команд js является вариант из пункта 2.

Как задаются комментарии в js?

Для того, чтобы было возможно поддерживать объемные программы на javascript, еще и несколькими разработчиками, просто необходимо использовать комментирование кода.

Записи, которые распознаются интерпретатором как комментарии, просто игнорируются им, потому в комменты можно заносить любую информацию и располагать ее в любом месте кода.

Выделяют две разновидности комментариев:

Однострочные

В начале ставится двойной слеш. Все, что идет после него до конца строки считается за комментарий:

//Первая команда выведет текст «Сообщение 1»
alert('Сообщение 1'); 
alert('Сообщение 2'); // вторая команда выведет текст «Сообщение 2»

Чаще всего используются для краткого описания функций и команд в коде.

Многострочные

Синтаксис многострочного комментария ничем не отличается от CSS: "/*" в начале и "*/" в конце.

/*Сейчас мы выведем два текстовых сообщения подряд
На экран пользователя, чтобы продемонстрировать
Действие этого примера*/
alert('Сообщение 1'); 
alert('Сообщение 2');

Обратите внимание!

Интерпретатор расценивает как комментарий все символы начиная от "/*" и заканчивая "*/", в этом есть маленький подвох:

/* 
alert('Сообщение 1'); /* какой-то текст */
*/
alert('Сообщение 2');

В этом примере alert('Сообщение 1'); будет расценено как комментарий, а часть «какой-то текст» вызовет ошибку в коде, поскольку интерпретатор оборвет коммент на первом символе "*/".

Мораль: вложенных комментариев в javascript нету.

Для чего чаще всего используются комментарии в js?

  1. В случае применения неочевидных алгоритмов в коде практически обязательно добавить комментарий дающий понять что делает эта часть кода?
  2. Порой для реализации поставленной задачи у нас есть несколько вариантов решений и для того, чтобы выбрать что нам подходит лучше всего приходится перелопатить кучу литературы. Сев за этот код снова через некоторое время можно не вспомнить почему было применено именно это решение. Для того, чтобы не пришлось разбираться во всем заново всегда отмечайте что и почему Вы выбрали в комментариях.
  3. Иногда приходится использовать одни вычисления и выражения в разных местах кода. Для того, чтобы потом среди этого всего не запутаться- комментируйте что откуда берется, что куда передается, почему выбрано именно это форматирование, а не другое и тд.

Подводя итоги

Чем больше комментариев- тем лучше. Они делают код понятней, позволяют упростить жизнь нам и тем, кто будет поддерживать наш код в дальнейшем, экономят тонны нервов на отлове ошибок из-за не очевидных приемов и присвоений в коде.

Оценок: 1 (средняя 5 из 5)

Оценка: 
Ключевые слова: 
Понравилась статья? Расскажите о ней друзьям: