JavaScript 代码规范学习笔记

在 JavaScript 开发中，遵循一定的代码规范可以保证代码的可读性、可维护性和可扩展性。本文将介绍 JavaScript 代码规范的一些实践和技巧。

命名规范

在 JavaScript 中，使用统一的命名规范可以让代码更易于理解和维护。以下是一些常见的命名规范：

变量和函数

使用有意义的名称，尽量避免缩写和简写。
变量和函数名应该以小写字母开头，并采用驼峰式命名法。
函数名一般以动词开头，例如 getUser。
常量应该全部大写，单词之间用下划线连接。

举个例子：

javascriptCopy Code
// good
const MAX_COUNT = 10;
let userName = '张三';

function getUser() {
  // ...
}

// bad
const mxCnt = 10;
let un = '张三';

function fetch() {
  // ...
}

类

类名应采用 PascalCase 命名法。
私有属性和方法应该以 _ 开头。

举个例子：

javascriptCopy Code
// good
class Person {
  constructor(name) {
    this.name = name;
  }

  getName() {
    return this.name;
  }
}

// bad
class person {
  constructor(name) {
    this.name = name;
  }

  GetName() {
    return this.name;
  }
}

缩进和空白

使用统一的缩进和空格规则可以使代码更易于阅读：

使用 2 个空格作为缩进。
在大括号前添加一个空格。
运算符两侧应该添加空格。

举个例子：

javascriptCopy Code
// good
if (condition) {
  // ...  
}

const sum = a + b;

// bad
if (condition){
  // ...
}

const sum=a+b;

注释

注释可以使代码更易于理解和维护。以下是一些常见的注释规范：

对于复杂的逻辑或者不易阅读的代码块，添加注释解释其含义。
对重要的函数或类添加文档注释。
注释应该写清楚、简洁，避免使用无意义的注释。

举个例子：

javascriptCopy Code
// good
// 计算两数之和
function add(a, b) {
  return a + b;
}

/**
 * Person 类
 * @param {string} name - 姓名
 * @param {number} age - 年龄
 */
class Person {
  constructor(name, age) {
    this.name = name;
    this.age = age;
  }
}

// bad
// 加法函数
function plus(a, b) {
  return a + b; // 计算结果
}

// 非常重要的 Person 类
class P {
  constructor(n, a) {
    this.n = n; // 名称
    this.a = a; // 年龄
  }
}

函数

函数是 JavaScript 中的核心概念之一。以下是一些常见的函数规范：

函数应该尽可能小，避免嵌套过深。
函数应该只做一件事。
尽量避免使用全局变量和副作用。
避免使用多个返回语句。
函数参数应该尽可能少。

举个例子：

javascriptCopy Code
// good
function createUser(name, email) {
  const user = {
    name,
    email,
  };

  saveUser(user);

  return user;
}

// bad
function createUser(user) {
  saveUser(user);
}

function saveUser(user) {
  // ...
}

异常处理

JavaScript 中的异常处理可以使程序更加健壮和可靠。以下是一些常见的异常处理规范：

在可能发生异常的地方添加异常处理代码。
在捕获异常后，应该对异常进行处理，例如输出错误日志或者回滚操作。

举个例子：

javascriptCopy Code
// good
try {
  fetch('http://example.com/data')
    .then(response => {
      // ...
    });
} catch (err) {
  console.error(err);
}

// bad
fetch('http://example.com/data')
  .then(response => {
    // ...
  })
  .catch(err => {
    console.error(err);
  });

总结

本文介绍了 JavaScript 代码规范的一些实践和技巧，包括命名规范、缩进和空白、注释、函数和异常处理等方面。在日常开发中，遵循这些规范可以使代码更易于理解和维护，提高开发效率和代码质量。