JavaScript 代码规范

代码规范是一套团队"约定俗成"的书写规则,让代码易读、易维护、易协作。JavaScript 语法很宽松,同样功能有上百种写法,因此社区归纳出通用规范(如 Google、Airbnb 风格)。照着统一的规则写,别人接手时就能少踩坑、快上手。

命名约定

  • 变量与函数:小驼峰 camelCase,如 userName、getUserById。
  • 构造函数与类:大驼峰 PascalCase,如 User、DatePicker。
  • 常量:全大写加下划线,如 MAX_SIZE、API_URL。
  • 布尔变量习惯加 is/has 前缀,如 isValid、hasChildren。
const userName = "小明";         // 变量小驼峰
const MAX_SIZE = 100;            // 常量全大写
function getUserById(id) {}      // 函数小驼峰
function User(name) {}           // 构造函数大驼峰

声明变量:const 与 let

  • 用 const 声明不会重新赋值的变量;需要改变才用 let;尽量不要用 var。
  • 每个变量单独声明,并在"用到它的地方就近声明"。
const count = 1; // 推荐:值不变
let total = 0;   // 需要累加,用 let
// var old = 1;  // 避免使用 var

for (let i = 0; i < 3; i++) {
  total += i;
}
console.log(total); // 输出:3

空格、缩进与花括号

  • 缩进统一用 2 或 4 个空格(团队定一种即可),不用 Tab。
  • 运算符两边各留一个空格:a + b 而不是 a+b。
  • 花括号不另起一行,且 { 前留一个空格:
// 规范写法
if (score >= 60) {
  console.log("及格");
}

比较与字符串

  • 一律用严格相等 === / !==,避免 == 的类型转换陷阱(0 == "0" 为 true)。
  • 引号全站统一(单引号或双引号选一种),不要混用。
  • 拼接长文本优先用模板字符串:
const name = "张三";
console.log(name === "张三"); // 输出:true
console.log(0 === "0");       // 输出:false(严格比较)
console.log(`你好,${name}!`); // 输出:你好,张三!

注释习惯

注释要解释"为什么这样做",而不是逐行翻译代码;函数建议用 JSDoc 风格说明参数与返回值:

/**
 * 计算两个数字之和
 * @param {number} a 第一个加数
 * @param {number} b 第二个加数
 * @returns {number} 两数之和
 */
function add(a, b) {
  return a + b;
}
console.log(add(1, 2)); // 输出:3

小结

规范的价值在于"统一":命名一看就懂用途、声明优先 const/let、缩进与空格一致、比较用 ===、注释讲清原因。把这些养成习惯,你的代码就能被团队愉快地阅读和维护。

笔记加载中…