ECMAScript 2016 参考指南：JavaScript 编码规范实例-JavaScript中文网-JavaScript教程资源分享门户

概述

随着 JavaScript 语言的快速发展，编程规范的重要性越来越凸显。一个合格的前端开发者需要掌握良好的编码规范，以避免代码质量下降、性能降低、维护难度加大等问题。本文参考了 ECMAScript 2016 规范，并结合实际开发经验，提出一些可行的、具体的规范实例，以供前端开发者参考使用。

命名规范

变量命名

变量命名应尽量见名知意，使用驼峰命名法，并避免使用特殊字符、保留字等。以下是一个变量命名的示例：

let userName = 'John'
let userAge = 20
let isMale = true
let userObj = {
  name: 'John',
  age: 20,
  isMale: true
}

函数命名

函数命名同样应尽量见名知意，使用驼峰命名法，并避免使用特殊字符、保留字等。以下是一个函数命名的示例：

function getUserInfo (userId) {
  // ...
}

常量命名

常量应该全部大写，使用下划线分隔单词，遵循描绘语义的方式命名。以下是一个常量命名的示例：

const PI = 3.1415926
const MAX_LENGTH = 20
const MIN_AGE = 18
const ENV_DEV = 'development'
const ENV_PROD = 'production'

代码风格

缩进

缩进使用 2 个空格为宜，要在代码块之间保留适当的空行，以提高可读性。以下是一个缩进示例：

function add (num1, num2) {
  if (typeof (num1) !== 'number' || typeof (num2) !== 'number') {
    return -1
  }

  return num1 + num2
}

空格

应在逗号、分号、括号等前后加入空格，增加可读性。以下是一个空格示例：

if (age > 18 && gender === 'male') {
  // ...
}

const sum = add(2, 3)

换行

当代码过长或不适合在一行中显示时，应使用换行，并且要与开头缩进对齐。以下是一个换行示例：

-- -------------------- ---- -------
----- ------- - -
  ----- -------
  ---- ---
  ------- -----
  ---------- -
    -----------
    -----------
    -----------
    -----------
    -----------
    ----------
  -
-

if-else 语句

if-else 语句中，应将判断表达式尽量简单化，以提高可读性。以下是一个 if-else 示例：

if (user && user.isMale && user.age > 18) {
  // do something
} else {
  // do something else
}

switch-case 语句

switch-case 语句中，依然要遵循简单化原则，并尽可能使用 break 让程序逻辑更加清晰。以下是一个 switch-case 示例：

-- -------------------- ---- -------
------ ----------- -
  ---- --
    ------ --------
    -----
  ---- --
    ------ --------
    -----
  ---- --
    ------ ---------
    -----
  ---- --
    ------ -----------
    -----
  ---- --
    ------ ----------
    -----
  ---- --
    ------ --------
    -----
  ---- --
    ------ ----------
    -----
  --------
    ------ --
    -----
-

总结

本文以 ECMAScript 2016 为参考，介绍了一些可行的、具体的 JavaScript 编码规范实例。这些规范实例可以帮助开发者避免编写低质量、难以维护的代码，提高程序的可读性和可维护性。但是，这只是一个参考，具体的编码规范实践需要根据团队开发和项目实际情况不断优化和调整。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/64afee1248841e9894c2af8f