Кодирование конвенций для записи JavaScript

Подписаться на мой список электронной почты сейчас http://jauyeung.net/subscribe/

Следуй за мной в Twitter в https://twitter.com/AuMayeung

Много других статей на https://medium.com/@hohanga

Еще больше статей на http://thewebdev.info/

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

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

Именование и декларация переменных, функций, классов и других объектов соответствует их схеме именования. Это означает, что мы можем проще понять код и сделать вещи более предсказуемыми.

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

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

Имена переменных должны быть чехол для верблюда. Это также относится к функциям.

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

Например, следующее хорошее:

let birthDay;

Однако следующее не так:

let 123birthday;

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

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

Например, следующее хорошее:

class Person {}

И следующее плохо:

class person {}

Константы должны быть весь верхний регистр. Так что это хорошо:

const FOO = 1;

Многие библиотеки начнут их идентификаторы с знаком доллара. Поэтому, чтобы избежать конфликта, мы должны начать наши идентификаторы с чем-то другим.

Там должно быть одно пространство между операндом и оператором для двоичных операторов, таких как + , - , = , * , / и после запятых.

Например, следующее хорошее:

let x = y + z;

Однако следующее плохое:

let x=y+z;

Выделенные запятыми предметы должны иметь одно пространство после запятой. Например, следующее хорошее:

foo(1, 2, 3);  
[1, 2, 3];

Но следующий код плохой:

foo(1,2,3);  
[1,2,3];

2 пробела для отступов является принятой конвенцией для отступа:

Например, следующее хорошее:

function foo() {  
  let x = 1;  
}

Но следующее плохое:

function foo() {  
     let x = 1;  
}

Лучше использовать пробелы вместо вкладок, поскольку вкладки интерпретируются по-разному различными программами и операционными системами.

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

Заявления должны заканчиваться с запятой в конце.

Например, следующее хорошее:

let x = 1;

Но это плохо:

let x = 1

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

Например, если у нас есть:

if (x === 1)  
  foo();  
  bar();

Тогда мы можем подумать, что фюра и бар Оба работают, когда х 1, но на самом деле, только Foo работает с момента только foo (); считается в Если блокировать.

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

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

Например, мы должны писать функции, такие как:

function foo() {  
  let x = 1;  
}

Условные заявления должны быть как:

if (x === 1) {  
  y = 1;  
} 
else {  
  y = 0;  
}

и петли должны быть как:

for (let i = 1; i <= 10; i++) {  
  y = x;  
}

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

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

Цитаты должны быть обернуты только вокруг струн.

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

Ниже приведен пример кода определения объекта с хорошим расстоянием:

let foo = {  
  a: 1,  
  b: 2,  
  c: 3  
}

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

let foo = { a: 1, b: 2 };

Линии более 80 символов предпочтительны для удобного чтения на меньших экранах. Мы можем сломать длинные линии в более короткие, поместив оставшуюся часть линии на следующую строку.

Windows FireNames не чувствительны к регистру. Тем не менее, большинство других операционных систем имеют данные чувствительными к регистру файлов. Следовательно, лучше всего назвать их всей строчными буквами, чтобы избежать проблем с корпусом имени файла.

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

Оригинал: “https://dev.to/aumayeung/coding-conventions-for-writing-javascript-1fch”