JavaScript常用代码书写规范的超全面总结

为什么需要代码规范

1. 维护代码的难易程度

当代码规范且易读时，修复代码会变得更加容易，维护更加简单。当代码被无序编写、或不符合一定的规范时，理解代码所要运行的语句将会非常困难。

2. 团队开发的重要性

当一组开发者在给定的工程环境下协同工作时，他们需要有一些标准来统一代码。另外，代码规范也需要有一组人来维护并进行贡献。

3. 可读性与性能之间的平衡

优秀的代码应该易于阅读和理解。有时，我们可能会写出非常高效的代码语句，但是这些语句可能并不利于别人的理解和自己的维护。

4. 避免常见的缺陷

代码规范通常会涉及到一些缺陷检测方式和提示。通过使用代码规范，可以帮助开发者检测和避免常见的代码问题，比如：不安全的状态控制，内存泄漏等。

JavaScript常见约定

下面是一些编写 JavaScript 代码时应该遵守的约定。

1. 声明

必须使用 var、let 或 const 来声明变量。变量必须赋值。禁止使用 null 或 undefined 显式初始化变量。

示例1：

// 声明变量
let score;

// 赋值变量
score = 80;

2. 代码风格

代码风格是指如何格式化、排版、命名、注释和使用语句等。良好的代码风格使代码易于阅读和理解。

示例2：

// 使用驼峰法命名变量和函数名
let userName;
function login() {
  // ...
}

// 使用花括号格式化代码块
if (score >= 60) {
  console.log('及格');
} else {
  console.log('不及格');
}

// 使用双引号包裹字符串
const message = "Hello world";

3. 语句

每条语句必须以 ; 结尾。禁止使用自动插入分号功能，以避免代码意外的行为。

示例3：

const score = 80;

// 使用分号来结束语句
if (score >= 60) {
  console.log('及格');
} else {
  console.log('不及格');
};

4. 函数

函数必须接收参数，并返回一个值。函数命名应该采用驼峰法，并且应该使用名词或动词+名词的形式。函数的参数名和变量名遵循相同的规则。函数体必须使用花括号括起来。

示例4：

// 函数命名为动词+名词形式
function getUser(userId) {
  // ...

  return user;
}

结论

通过以上的总结，我们可以看到代码规范对于 JavaScript 代码的写作至关重要。它可以使我们的代码维护变得更加容易，使我们的团队更加有协作性，并帮助我们避免常见的缺陷。