Как правильно оформить код JavaScript

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

Отступы

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

Фигурные скобки                 

Некоторые разработчики предпочитают не использовать фигурные скобки, если тело инструкции if или for состоит из одной инструкции, например:

var a = 2;
if (a < 5)
   console.log('a меньше 5');

Но не стоит так делать, если ниже придется добавить еще одну строчку кода, например:

var a = 2;
var b = 7;
if (a < 5)
   console.log('a меньше 5');
   console.log('b равно ' + b);

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

var a = 2;
var b = 7;
if (a < 5) {
   console.log('a меньше 5');
}
console.log('b равно ' + b);

То же самое следует делать и с циклом for:

var a = 7;
for (var i = 0; i < 10; i ++) {
    console.log(i);
}
console.log('a равно ' + a);

Расположение открывающей скобки

Программисты используют один из ниже приведенных способов расположения открывающей скобки:

if (a < 5) {
    console.log('a меньше 5');
}

Или:

if (a < 5)
{
    console.log('a меньше 5');
}

Каждый располагает скобку так, как ему удобней. Однако в некоторых ситуациях поведение скрипта может быть разное. А все потому, что в языке программирования JavaScript действует механизм подстановки точки с зяпятой - это когда можно не использовать символ точки запятой в конце строки. Во время интерпретации кода она будет автоматически добавлена, но появляется проблема, во время которой все что находится ниже пропущенной точки с запятой может не выполниться. Например:

function funcExample() {
    return
    {
       name: 'Example function'

    };
}

По идее, функция должна вернуть объект со свойством name, но так как интерпретатор кода JavaScript считает, что после retrun возможно пропущена точка с запятой, то все что располагается ниже return не сработает. Поэтому функция вернет значение undefined.

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

function funcExample() {
    return {
        name: 'Example function'
    };
}

Так что следует всегда использовать скобки.

Пробелы

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

• после точек с запятой, например в цикле for:

for (var i = 0; i < 10; i ++) {
    console.log(i);
}

• при инициализации нескольких переменных, например:

var a = 5, b = 7;

• между элементами массива:

var a = [1, 2, 3];

• между аргументами функций и перед фигурными скобками:

function funcExample(a, b, c)  {

}

• после слова function в анонимных функциях:

var myExample = function () {
    console.log('example anonim function');
}