Рекомендации по использованию JavaScript - пробелы

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

В этой статье мы рассмотрим, как правильно разделить код JavaScript.

Используйте отступ для создания длинных цепочек методов

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

Например, вместо того, чтобы писать:

$('#foo').find('.selected').highlight().end().find('.bar').count;

Вместо этого мы пишем:

$('#foo')
  .find('.selected')
  .highlight()
  .end()
  .find('.bar')
  .count;

Оставляйте пустую строку после блоков и перед следующими операторами

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

Например, вместо написания:

if (foo) {
  return foo;
}
return baz;

Мы пишем:

if (foo) {
  return foo;
}
return baz;

Гораздо понятнее разделить их пустой строкой.

Не заполняйте блоки пустыми линиями

Мы не должны заполнять блоки пустыми строками.

Это потому, что они не улучшают читаемость и занимают место.

Например, вместо написания:

function foo() {

  console.log('bar');

}

Мы пишем:

function bar() {
  console.log(foo);
}

Не используйте несколько пустых строк

Не следует использовать несколько пустых строк, поскольку они занимают место и не улучшают читаемость.

Например, вместо того, чтобы писать:

const fullName = 'joe';

const email = '[email protected]';

Мы пишем:

const fullName = 'joe';
const email = '[email protected]';

Не добавляйте пробелы внутри скобок

Пробелы в скобках не нужны.

Например, вместо написания:

function baz( foo ) {
  return foo;
}

Мы пишем:

function baz(foo) {
  return foo;
}

Не добавляйте пробелы в скобки

Точно так же мы не должны добавлять пробелы в круглые скобки.

Например, вместо написания:

const foo = [ 1, 2, 3 ];

Мы пишем:

const foo = [1, 2, 3];

Если мы обращаемся к записям массива или свойствам объекта, вместо того, чтобы писать:

foo[ 1 ]

Мы пишем:

foo[1]

И вместо того, чтобы писать:

bar[ 'baz' ]

Мы пишем:

bar['baz']

Добавить пробелы внутри фигурных скобок

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

Например, вместо написания:

const foo = {baz: 1};

Мы должны написать:

const foo = { baz: 1 };

С дополнительными пробелами код намного легче читать.

Избегайте строк кода длиной более 100 символов

Строки кода длиннее 100 символов могут выходить за пределы экранов людей.

В этом случае им нужно прокрутить по горизонтали, чтобы прочитать всю строку.

Чтобы этого избежать, мы должны длина наших строк кода не более 100 символов.

Согласованный интервал внутри открытого блока и следующего токена на одной строке

У нас должен быть постоянный интервал между открытым блоком и следующим токеном.

Например, вместо написания:

function foo() {return 'bar';}

Мы должны написать:

function foo() {
  return 'bar';
}

Дополнительные пробелы облегчают чтение нашей функции.

Избегайте пробелов перед запятыми и требуйте пробелов после запятых

У нас должны быть пробелы перед запятой и один пробел после запятой.

Например, вместо написания:

const arr = [1 , 2];

Мы должны написать:

const arr = [1, 2];

Это гораздо более читабельно.

Принудительное использование интервала внутри скобки вычисляемого свойства

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

Например, вместо написания:

obj[foo ]

Мы пишем:

obj[foo]

Между функцией и ее вызовом нет пробелов

Нам не нужен пробел между функцией и ее вызовом.

Например, вместо того, чтобы писать:

foo ();

or:

foo
()

Мы пишем:

foo();

Наличие промежутков между ключами и значениями в свойствах литерала объекта

У нас должны быть пробелы между ключами и значениями в свойствах литералов объекта.

Например, вместо того, чтобы писать:

const obj = {foo:1};

Мы должны написать:

const obj = {
  foo: 1
};

Без конечных пробелов в конце строк

Завершающий пробел в конце строки бесполезен.

Следовательно, мы должны удалить их, если они есть.

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

Заключение

У нас должны быть интервалы там, где они нужны, например, в парах "ключ-значение" объектов.

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