bugl
bugl
HomeLearnPatternsSearch
HomeLearnPatternsSearch

Loading lesson path

Learn/JavaScript/JavaScript Foundations
JavaScript•JavaScript Foundations

JavaScript Style Guide

Always use the same coding conventions for all your JavaScript projects.

JavaScript Coding Conventions

Coding conventions are style guidelines for programming.

They typically cover:

Naming and declaration rules for variables and functions. Rules for the use of white space, indentation, and comments. Programming practices and principles.

Coding conventions secure quality

Improve code readability

Make code maintenance easier

Coding conventions can be documented rules for teams to follow, or just be your individual coding practice. This page describes the general JavaScript code conventions used by W3Schools. You should also read the next chapter "Best Practices", and learn how to avoid coding pitfalls.

Variable Names

At W3schools we use camelCase for identifier names (variables and functions). All names start with a letter. At the bottom of this page, you will find a wider discussion about naming rules.

firstName = "John";
lastName = "Doe";
price = 19.90;
tax = 0.20;
fullPrice = price + (price * tax);

Spaces Around Operators

Always put spaces around operators ( = + - * / ), and after commas:

Examples:

let x = y + z;
const myArray = ["Volvo", "Saab",
"Fiat"];

Code Indentation

Always use 2 spaces for indentation of code blocks:

Functions:

function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
Do not use tabs (tabulators) for indentation. Different editors interpret tabs differently.

Statement Rules

General rules for simple statements:

Always end a simple statement with a semicolon.

Examples:

const cars = ["Volvo", "Saab",
"Fiat"];
const person = {
firstName: "John", lastName: "Doe", age: 50, eyeColor:
"blue"
};
General rules for complex (compound) statements:

Put the opening bracket at the end of the first line. Use one space before the opening bracket. Put the closing bracket on a new line, without leading spaces. Do not end a complex statement with a semicolon.

Functions:

function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}

Loops:

for (let i = 0; i < 5; i++) {
x += i;
}

Conditionals:

if (time < 20) {
greeting = "Good day";
} else {
greeting = "Good evening";
}

Object Rules

General rules for object definitions:

Place the opening bracket on the same line as the object name. Use colon plus one space between each property and its value. Use quotes around string values, not around numeric values.

Formula

Do not add a comma after the last property - value pair.

Place the closing bracket on a new line, without leading spaces. Always end an object definition with a semicolon.

Example

const person = {
firstName: "John", lastName: "Doe", age: 50, eyeColor:
"blue"
};

Short objects can be written compressed, on one line, using spaces only between properties, like this:

const person = {firstName:"John", lastName:"Doe", age:50, eyeColor:"blue"};

Formula

Line Length < 80
For readability, avoid lines longer than 80 characters.
If a JavaScript statement does not fit on one line, the best place to break it, is after an operator or a comma.

Example

document.getElementById("demo").innerHTML =

"Hello Dolly.";

Naming Conventions

Always use the same naming convention for all your code. For example:

Variable and function names written as camelCase

Global variables written in

Previous

JavaScript Data Types

Next

JavaScript Introduction