Оформлении кода
Общепринятые правила оформления кода в JavaScript.
js
Следование правилам оформления кода помогает создавать понятный и легко поддерживаемый код.
Источник — JavaScript Patterns:
В конспекте →
Горизонтальные отступы
| function outer(a, b) { | |
| var c = 1, | |
| d = 2, | |
| inner; | |
| if (a > b) { | |
| inner = function () { | |
| return { | |
| r: c - d | |
| }; | |
| }; | |
| } else { | |
| inner = function () { | |
| return { | |
| r: c + d | |
| }; | |
| }; | |
| } | |
| return inner; | |
| } |
Использовать фигурные скобки даже когда это не обязательно
| if (true) { | |
| alert(1); | |
| } else { | |
| alert(2); | |
| } |
Фигурная скобка на линии оператора
| function func() { | |
| return { | |
| name: "Batman" | |
| }; | |
| } |
Пробелы для улучшения читаемости
| var d = 0, | |
| a = b + 1; | |
| if (a && b && c) { | |
| d = a % c; | |
| a += d; | |
| } |
API Docs
| /** | |
| * Reverse a string | |
| * | |
| * @param {String} input String to reverse | |
| * @return {String} The reversed string | |
| */ | |
| var reverse = function (input) { | |
| // ... | |
| return output; | |
| }; |
Именование
Camel Case для именования функций. Функции с конструктором с заглавной буквы.
| function MyConstructor() {...} | |
| function myFunction() {...} |
Константы
var MAX_VALUE = 299;
Приватные переменные
_private = "hidden";
Источник — JavaScript Patterns:
В конспекте →