仅使用小写。所有代码均使用小写，字符串除外。

删除行尾空格。行尾空格属于多余的符号，会使 diff 更加难以阅读。

• 对于 Atom 编辑器可以进行下图设置，保存文件自动去除行尾多余空格。
  

  

• 对于 Sublime Text 编辑器，可在用户设置 User Settings 的 JSON 文件（可在文本编辑器的菜单中找到）中添加以下代码，每当你以此方法储存文件时，去除行尾空格操作便会自动完成： "trim_trailing_white_space_on_save": true
• 对于 VS Code，可进入（菜单）首选项 -> 设置 中搜索 files.trimTrailingWhitespace ，然后将选项勾选即可，这样每当你保存文件时，去除行尾空格操作便会自动完成："files.trimTrailingWhitespace": true

所有选择符和声明均需另起一行。

h1, h2, h3 {
    font-weight: normal; line-height: 1.2;
}

h1,
h2,
h3 {
    font-weight: normal;
    line-height: 1.2;
}

所有规则间均需加一个空行（两个换行符）。

html {
    background: #fff;
}
body {
    margin: auto;
    width: 50%;
}

在可行时，用注释将样式表区块组合在一起，用新行分隔各区块。

/* Header */
.header {
    ...
}
.header-nav {
    ...
}
/* Content */
.gallery {
    ...
}
.gallery-img {
    ...
}
/* Footer */
.footer {
    ...
}
.footer-nav {
    ...
}

• 函数名称为 functionNames
• 变量名称为 variableNames
• 类名称为 ClassNames
• 方法名称为 methodNames
• 常量值名称为 CONSTANT_VALUES
• 文件名称为 filenames

好的注释可以使我们更好地维护代码，一段时间之后依然可以更高效地回到代码高效开发。一般用注释来解释描述框架（对组件进行高层次的整体概括）、记录函数的参数和用法（推荐使用 JSDoc 语法）。

此外解决方案的注释非常的重要，为何使用当前的方法（而非另一种方案），它们可以帮助你以正确的方式继续开发。如果代码存在任何巧妙和不显而易见的方法，那绝对需要注释。

选择基于 JSDoc 格式编写代码注释，可以利用 JSDoc 3 生成器将源代码中的注释识别提取出来，并生成一个HTML文档，用以对 JavaScript 功能进行记录和解释，方便其他开发者使用脚本。

JSDoc 会为你提供记录代码的多种注释，但只推荐使用以下种类：

• @constructor：用于记录一个 Class 类，也就是用 new 关键字调用的函数。
• @description：用于描述你的函数
• @param：用于描述函数参数
• @returns：用于描述函数返回值

/**
* @description 简要描述这本书
* @constructor
* @param {string} title - 书的标题
* @param {string} author - 书的作者
* @returns {string} book - 书的信息
*/
function Book(title, author) {
    let book = title + ' - ' + author;
    return book;
}

文件 book.js 为目标文件

jsdoc book.js

在 JavaScript 里一共有三种定义变量的方式：

• const
• let
• var

优先考虑使用 const 定义你的变量；如果觉得以后需要对变量重新赋值的，则使用 let。

始终在语句末尾使用分号 ; 依靠隐式插入会造成难以排除的细微问题。

const foo = function() {
   return true;
};
function foo() {
   return true;
}

for-in 循环用于循环对象中的键，且对于数组和对象行为不一致（for-in 不是从 0 循环到 length-1 ，而是循环对象及其原型链中的所有现有键），很容易出错，

如果可以的话，对数据进行整理，这样就不必在对象上迭代；如果不可行，就将 for-in 循环的内容包裹在条件语句中，以防止它在原型链上迭代。

const myObj = {'firstName':'Ada','lastName':'Lovelace'};
for (const key in myObj) {
   if (myObj.hasOwnProperty(key)) {
      console.log(myObj[key]);
   }
}

在迭代数组时，相比 for-in 循环， forEach 或 for 循环更具优势。

使用数组和对象字面量，而不是数组和对象构造函数。

const myArray = new Array(x1, x2, x3);
const myObject = new Object();
myObject.a = 0;

const myArray = [x1, x2, x3];
const myObject = {
   a: 0
};

为了保持连贯性，应使用单引号 ' 而不是双引号 "。这在创建含有 HTML 的字符串时尤其有帮助。

const element = 'Click Me';

短路求值可以提高性能。

function foo(name) {
   let theName;
   if (name) {
      theName = name;
   } else {
      theName = 'John';
   }
   return theName;
}

function foo(name) {
   return theName = name || 'John';
}