ЛУЧШИЙ САЙТ ДЛЯ ВЕБ-РАЗРАБОТЧИКОВ

JS Учебник

JS Старт JS Введение JS Установка JS Вывод JS Объявления JS Синтаксис JS Комментарии JS Переменные JS Операторы JS Арифметические JS Присваивание JS Типы данных JS Функции JS Объекты JS События JS Строки JS Методы строки JS Числа JS Методы числа JS Массивы JS Методы массива JS Сортировка массива JS Итерация массива JS Даты JS Форматы дат JS Методы получения дат JS Методы установки дат JS Математические JS Рандомные JS Булевы JS Сравнения JS Условия JS Switch JS Цикл For JS Цикл While JS Прерывание JS Преобразование типов JS Побитовые JS Регулярные выражения JS Ошибки JS Область действия JS Подъём JS Строгий режим JS Ключевое слово this JS Ключевое слово Let JS Ключевое слово Const JS Функции стрелок JS Классы JS Отладка JS Гид по стилю JS Лучшие практики JS Ошибки JS Производительность JS Зарезервированные слова JS Версии JS Версия ES5 JS Версия ES6 JS JSON

JS Формы

JS Формы Формы API

JS Объекты

Определения объектов Свойства объекта Методы объекта Доступ к объектам Конструкторы объектов Прототипы объектов Объект ECMAScript 5

JS Функции

Определения функций Параметры функции Обращение к функции Вызов функции Применение функции Закрытие функции

JS HTML DOM

DOM Введение DOM Методы DOM Документ DOM Элементы DOM HTML DOM CSS DOM Анимация DOM События DOM Слушатель событий DOM Навигация DOM Узлы DOM Коллекции DOM Узловые списки

JS Объектная модель браузера BOM

JS Окно JS Скрин JS Локация JS История JS Навигатор JS Всплывающее оповещение JS Тайминг JS Куки

JS AJAX

AJAX Введение AJAX XMLHttp AJAX Запрос AJAX Отклик AJAX XML Файл AJAX PHP AJAX ASP AJAX База данных AJAX Приложения AJAX Примеры

JS JSON

JSON Введение JSON Синтаксис JSON и XML JSON Типы данных JSON Анализ JSON Stringify JSON Объекты JSON Массивы JSON PHP JSON HTML JSON JSONP

JS и jQuery

jQuery Селекторы jQuery HTML jQuery CSS jQuery DOM

JS Примеры

JS Примеры JS HTML DOM JS HTML Input JS HTML Объекты JS HTML События JS Броузер JS Упражнения JS Викторина JS Сертификат

JS Справочники

JavaScript Объекты HTML DOM Объекты

JavaScript. Уроки для начинающих

JavaScript Руководство по стилю и условные обозначения


Всегда используйте одни и те же соглашения о кодировании для всех ваших проектов JavaScript.


Соглашения о кодировании JavaScript

Соглашения о кодировании - это рекомендации по стилю программирования. Они обычно включают:

  • Правила именования и объявления для переменных и функций
  • Правила использования пробелов, отступов и комментариев
  • Практику и принципы программирования

Правила кодирования secure quality (безопасного качества):

  • Улучшает читабельность кода
  • Делает обслуживание кода проще

Соглашения о кодировании могут быть задокументированными правилами, которым должны следовать команды, или просто быть вашей индивидуальной практикой кодирования.

На этой странице описаны общие соглашения кода JavaScript, используемые W3Schools.
Вам необходимо также прочитать следующую главу JavaScript. Лучшие практики, чтобы узнать, как избежать ошибок при кодировании.


Имена переменных

В W3schools используется camelCase (верблюжий регистр) для имен идентификаторов (переменных и функций).

Все имена начинаются с буквы.

В нижней части этой страницы вы найдете более широкое обсуждение правил именования.

firstName = "John";
lastName = "Doe";

price = 19.90;
tax = 0.20;

fullPrice = price + (price * tax);

Пробелы вокруг операторов

Всегда ставьте пробелы вокруг операторов ( = + - * / ), и после запятых:

Примеры:

var x = y + z;
var values = ["Volvo", "Saab", "Fiat"];

Отступ кода

Всегда используйте 2 пробела для отступа блоков кода:

Функции:

function toCelsius(fahrenheit) {
  return (5 / 9) * (fahrenheit - 32);
}

Не используйте табы (табуляторы) для отступов. Разные редакторы по-разному интерпретируют табы.


Правила объявлений (инструкций)

Общие правила для простых объявлений:

  • Всегда заканчивайте простое объявление точкой с запятой.

Примеры:

var values = ["Volvo", "Saab", "Fiat"];

var person = {
  firstName: "John",
  lastName: "Doe",
  age: 50,
  eyeColor: "blue"
};

Общие правила для сложных (составных) объявлений:

  • Поместите открывающую скобку в конце первой строки.
  • Используйте один пробел перед открывающей скобкой.
  • Поместите закрывающую скобку на новую строку без пробелов.
  • Не заканчивайте сложное объявление точкой с запятой.

Функции:

function toCelsius(fahrenheit) {
  return (5 / 9) * (fahrenheit - 32);
}

Циклы:

for (i = 0; i < 5; i++) {
  x += i;
}

Условное выражение:

if (time < 20) {
  greeting = "Good day";
} else {
  greeting = "Good evening";
}

Правила объекта

General rules for object definitions:

  • Поместите открывающую скобку в ту же строку, что и имя объекта.
  • Используйте двоеточие плюс один пробел между каждым свойством и его значением.
  • Используйте кавычки вокруг строковых значений, а не вокруг числовых значений.
  • Не добавляйте запятую после последней пары свойство-значение.
  • Поместите закрывающую скобку на новую строку, без пробелов.
  • Всегда заканчивайте определение объекта точкой с запятой.

Пример

var person = {
  firstName: "John",
  lastName: "Doe",
  age: 50,
  eyeColor: "blue"
};

Короткие объекты могут быть записаны сжатыми в одну строку, используя пробелы только между свойствами, как здесь:

var person = {firstName:"John", lastName:"Doe", age:50, eyeColor:"blue"};

Длина строки < 80

Для удобства чтения избегайте строк длиной более 80 символов.

Если JavaScript объявление (инструкция, оператор) не помещается в одну строку, лучше всего его разбить после объявления или запятой.

Пример

document.getElementById("demo").innerHTML =
"Hello Dolly.";
Попробуйте сами »

Соглашения об именах

Всегда используйте одно и то же соглашение об именах для всего вашего кода. Например:

  • Имена переменных и функций записываются как camelCase (верблюжий регистр)
  • Глобальные переменные записываются в UPPERCASE - ВЕРХНЕМ РЕГИСТРЕ. (Мы так не делаем, но это встречается довольно часто)
  • Константы (например, число PI) записываются в UPPERCASE - ВЕРХНЕМ РЕГИСТРЕ

Следует ли использовать де-фисы, верблюжийРегистр или под_чёркивания в именах переменных?

Этот вопрос часто обсуждают программисты. Ответ зависит от того, кого вы спрашиваете:

Дефисы в HTML и CSS:

Атрибуты HTML5 могут начинаться с data- (data-quantity, data-price).

CSS использует дефисы в именах свойств (font-size).

В JavaScript дефисы могут быть ошибочно приняты за попытки вычитания. Дефисы не допускаются в именах JavaScript.

Подчёркивания:

Многие программисты предпочитают использовать подчеркивание (date_of_birth), особенно в базах данных SQL.

Подчеркивания часто используются в документации PHP.

PascalCase:

PascalCase часто предпочитают программисты на языке C.

camelCase:

camelCase используется самим JavaScript, jQuery и другими библиотеками JavaScript.

Не начинайте имена со знака $. Это поставит вас в конфликт со многими именами библиотек JavaScript.


Загрузка JavaScript в HTML

Используйте простой синтаксис для загрузки внешних скриптов (атрибут type НЕ НУЖЕН, как было в предыдущих версиях HTML):

<script src="myscript.js"></script>

Доступ к HTML элементам

Следствие использования "грязных", "беспорядочных" HTML стилей может привести к ошибкам JavaScript:

var obj = getElementById("Demo")

var obj = getElementById("demo")

Если возможно, используйте то же соглашение об именах (как JavaScript) в HTML.

Для ознакомления посетите Гид по HTML стилю.


Расширения файлов

HTML-файлы должны иметь расширение .html (не .htm).

CSS-файлы должны иметь расширение .css.

JavaScript-файлы должны иметь расширение .js.


Используйте имена файлов в нижнем регистре

Большинство веб-серверов (Apache, Unix) чувствительны к регистру имен файлов:

london.jpg не может быть доступен как London.jpg.

Другие веб-серверы (Microsoft, IIS) не чувствительны к регистру:

london.jpg может быть доступен как London.jpg или london.jpg.

Если вы используете сочетание верхнего и нижнего регистра, вы должны быть чрезвычайно последовательными.

Если вы перейдете с нечувствительного к регистру сервера на чувствительный к регистру сервер, даже небольшие ошибки могут испортить ваш веб-сайт и он перестанет работать.

Чтобы избежать этих проблем, всегда используйте имена файлов в нижнем регистре (если это возможно).


Производительность

Соглашения о кодировании не используются компьютерами. Большинство правил мало влияют на выполнение программ.

Отступы и лишние пробелы не важны в маленьких скриптах.

Для кода в разработке удобочитаемость должна быть предпочтительной. Большие производственные скрипты должны быть уменьшены, насколько это возможно.