Стиль кодирования JavaScript

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

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

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

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

У нас есть некоторые правила, которые действительны для всех языков программирования.

Стиль кодирования – это соглашение с самим собой и вашей командой для обеспечения согласованности в проекте.

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

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

Будьте последовательны в соответствии с проектом, над которым вы работаете

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

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

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

Мои собственные предпочтения

Мой собственный взгляд на стиль JavaScript таков:

Всегда используйте последнюю версию ES. Используйте Babel, если необходима поддержка старого браузера.

Отступ : используйте пробелы вместо табуляции, отступ используйте 2 пробела.

Точки с запятой : не используйте точки с запятой.

Длина строки : попробуйте сократить строки на 80 символов, если это возможно.

Встроенные комментарии : используйте встроенные комментарии в своем коде. Используйте комментарии блока только для документирования.

Нет мертвого кода : Не оставляйте старый код прокомментированным, “на всякий случай” это будет полезно позже. Сохраняйте только тот код, который вам сейчас нужен, для этого предназначено приложение “Контроль версий”/”Заметки”.

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

Объявления переменных : всегда объявляйте переменные, чтобы избежать загрязнения глобального объекта. Никогда не используйте var . По умолчанию константа , использовать только позвольте , если вы переназначаете переменную.

Функции : используйте функции со стрелками, если у вас нет особых причин использовать обычные функции, например, в методах объектов или конструкторах, из-за того, как это работает. Объявите их как const и используйте неявные возвраты, если это возможно.

const test = (a, b) => a + b

const another = a => a + 2

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

Имена : имена функций, имена переменных и имена методов всегда начинаются со строчной буквы (если вы не идентифицируете их как частные, читайте ниже) и имеют верблюжью форму. Только функции конструктора и имена классов должны начинаться с заглавной буквы. Если вы используете структуру, требующую определенных соглашений, измените свои привычки соответствующим образом. Все имена файлов должны быть в нижнем регистре, со словами, разделенными - .

Форматы и правила для конкретных заявлений :

если

if (condition) {
  statements
}

if (condition) {
  statements
} else {
  statements
}

if (condition) {
  statements
} else if (condition) {
  statements
} else {
  statements
}

для

Всегда инициализируйте длину в инициализации, чтобы кэшировать ее, не вставляйте ее в условие.

Избегайте использования для в , за исключением случаев, когда используется в сочетании с .hasOwnProperty () . Предпочитаю для (см. Циклы JavaScript )

for (initialization; condition; update) {
  statements
}

пока

while (condition) {
  statements
}

делать

do {
  statements
} while (condition);

переключатель

switch (expression) {
  case expression:
    statements
  default:
    statements
}

пробовать

try {
  statements
} catch (variable) {
  statements
}

try {
  statements
} catch (variable) {
  statements
} finally {
  statements
}

Пробел : используйте пробелы с умом для улучшения читабельности: поставьте пробел после ключевого слова, за которым следует ( ; до и после двоичной операции ( + , - , / , * , && ..) ; внутри оператора for, после каждого ; для разделения каждой части оператора; после каждого , .

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

Кавычки предпочитайте одинарные кавычки ' вместо двойных кавычек " . Двойные кавычки являются стандартом в атрибутах HTML, поэтому использование одинарных кавычек помогает устранить проблемы при работе со строками HTML. Используйте шаблонные литералы , когда это уместно, вместо интерполяции переменных.

Оригинал: “https://flaviocopes.com/javascript-coding-style/”

Популярные Руководства по стилю

Будьте последовательны в соответствии с проектом, над которым вы работаете

Мои собственные предпочтения

Читайте ещё по теме: