Всегда используйте одни и те же правила кодирования для всех ваших проектов JavaScript.
Кодирование конвенции JavaScript
Coding конвенции являются стиль руководящих принципов для программирования. Как правило, они охватывают:
- Присвоению имен и декларации правил для переменных и функций.
- Правила использования белого пространства, отступы и комментарии.
- Программирование практики и принципы
Coding конвенции безопасного качества:
- Улучшает читаемость кода
- Сделать обслуживание код проще
Coding конвенции могут быть задокументированы правила для команд, чтобы следовать, или просто быть ваша индивидуальная практика кодирования.
На этой странице описаны общие соглашения, код JavaScript, используемые w3ii.
Вы также должны прочитать в следующей главе "наилучшей практики", и узнать, как избежать кодирования ошибок.
Имена переменных
В w3ii мы используем CamelCase для имен идентификаторов (переменных и функций).
Все имена начинаются с буквы.
В нижней части этой страницы, вы найдете более широкое обсуждение правила именования.
firstName = "John";
lastName = "Doe";
price = 19.90;
tax = 0.20;
fullPrice = price + (price * tax);Пробелы вокруг операторов
Всегда ставьте пробелы вокруг операторов ( = + - * / ) , а после запятой:
Примеры:
var x = y + z;
var values = ["Volvo", "Saab",
"Fiat"];Код Отступ
Всегда используйте 4 пробела для отступа кодовых блоков:
Функции:
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
Не используйте вкладки (табуляторов) для отступов. Различные редакторы интерпретировать вкладки по-разному.
Заявление Правила
Общие правила для простых утверждений:
- Всегда заканчивайте простое заявление с точкой с запятой.
Примеры:
var values = ["Volvo", "Saab",
"Fiat"];
var person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor:
"blue"
};Общие правила для сложных (составных) отчетности:
- Поместите открывающую скобку в конце первой строки.
- Используйте один пробел до открывающейся скобки.
- Установите закрывающую скобку на новой линии, без ведущих пробелов.
- Не прерывайте сложное заявление с точкой с запятой.
Функции:
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
Петли:
for (i = 0; i < 5; i++) {
x += i;
}Conditionals:
if (time < 20) {
greeting = "Good day";
} else {
greeting = "Good evening";
}Правила Object
Общие правила для определения объектов:
- Поместите открывающую скобку на той же строке, что и имя объекта.
- Используйте двоеточие плюс один пробел между свойством и его значением.
- Используйте кавычки вокруг значений, а не вокруг числовых значений.
- Не добавлять запятую после пары последнее свойство-значение.
- Установите закрывающую скобку на новой линии, без ведущих пробелов.
- Всегда заканчивайте определение объекта с точкой с запятой.
пример
var person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor:
"blue"
};Короткие объекты могут быть записаны сжатые, на одной строке, используя пробелы только между свойствами, например:
var person = {firstName:"John", lastName:"Doe", age:50, eyeColor:"blue"};Длина линии <80
Для удобства чтения, избегать линий длиной более 80 символов.
Если оператор JavaScript не помещается на одной строке, лучшее место, чтобы разбить его, после оператора или запятой.
Соглашения по именованию
Всегда используйте один и тот же именования для всех вашего кода. Например:
- Переменные и имена функций записывается в виде CamelCase
- Глобальные переменные , написанные в верхнем регистре (мы не, но это довольно часто)
- Константы (например , PI) , написанные в верхнем регистре
Если вы используете Hyp-несушек, верблюжьего или under_scores в именах переменных?
Это вопрос, программисты часто обсуждают. Ответ на этот вопрос зависит от того, кого вы спрашиваете:
Переносов в HTML и CSS:
HTML5 атрибуты могут начинаться с данные- (на основе данных, количество данных цены).
CSS использует дефисы в названиях свойств (размер шрифта).
Дефисы может быть ошибочно, как попытки вычитания. Дефис не допускаются в именах JavaScript.
подчеркивает:
Многие программисты предпочитают использовать нижнее подчеркивание (date_of_birth), особенно в базах данных SQL.
Подчеркивания часто используются в PHP документации.
PascalCase:
PascalCase часто предпочитают программисты C.
CamelCase:
CamelCase используется сам JavaScript, с помощью JQuery и других библиотек JavaScript.
Не начинайте имена с знака $. Это поставит вас в конфликт с многими именами библиотек JavaScript.
Загрузка JavaScript в HTML
Используйте простой синтаксис для загрузки внешних скриптов (атрибут типа не требуется):
<script src="myscript.js">
Доступ к HTML Elements
Следствием использования "неопрятный" стили HTML, может привести к ошибкам JavaScript.
Эти два JavaScript заявления будут давать различные результаты:
var obj =
getElementById("Demo")
var obj = getElementById("demo")
Если это возможно, использовать один и тот же именования (как JavaScript) в HTML.
Посетите Руководство Стиль HTML .
Расширения файлов
HTML - файлы должны иметь расширение .html (не НТМ).
CSS файлы должны иметь расширение .css.
JavaScript - файлы должны иметь расширение .js.
Использование в нижнем регистре имен файлов
Большинство веб-серверов (Apache, Unix) являются чувствительными к регистру об именах файлов:
london.jpg не могут быть доступны как London.jpg .
Другие веб-серверов (Microsoft, IIS) не чувствительны к регистру:
london.jpg могут быть доступны как London.jpg или london.jpg .
Если вы используете сочетание верхнего и нижнего регистра, то вы должны быть очень последовательным.
Если перейти от чувствителен к регистру к чувствительному серверу случае, даже небольшие ошибки может привести к поломке вашего веб-сайта.
Чтобы избежать этих проблем, всегда использовать более низкие имена файлов случай (если это возможно).
Представление
Coding конвенции не используются компьютерами. Большинство правил имеют незначительное влияние на выполнение программ.
Отступов и лишних пробелов, не являются существенными в маленьких сценариях.
Для получения кода в процессе развития, следует предпочесть читаемость. Большие производственные сценарии должны быть минимизированы.