JavaScript开发规范的核心目标是让代码具备一致性、可读性和可维护性,无论是个人项目还是团队开发,遵循统一的规范都能降低沟通成本,减少不必要的错误。规范的制定不需要过于复杂,重点覆盖日常开发的高频场景即可。

变量与常量声明规范
变量和常量的声明是基础但容易出错的环节,遵循以下规则能避免很多作用域相关的问题:
- 优先使用
const声明不会被重新赋值的变量,需要重新赋值的场景再使用let,禁止使用var声明变量,避免变量提升带来的作用域混乱。 - 变量命名采用小驼峰命名法,语义要清晰,避免使用a、b、temp这类无意义的名称,布尔类型的变量建议以is、has、can开头,比如
isLogin、hasPermission。 - 常量命名全部使用大写字母,多个单词之间用下划线连接,比如
MAX_REQUEST_COUNT、API_BASE_URL。
// 正确的变量声明示例 const USER_NAME = 'test_user'; // 常量 let currentPage = 1; // 需要重新赋值的变量 const isLogin = true; // 布尔类型变量 // 错误的声明示例 var temp = 10; // 禁止使用var let a = 20; // 变量名无意义
函数设计规范
函数是JavaScript的核心组成部分,良好的函数设计能提升代码的复用性和可读性:
- 函数命名同样采用小驼峰命名法,名称要体现函数的功能,比如
getUserInfo、calculateTotalPrice,避免使用func1、handle这类模糊的名称。 - 函数的参数个数尽量控制在3个以内,超过3个的参数建议使用对象传递,方便后续扩展参数,也避免参数顺序传错的问题。
- 函数要保持单一职责,一个函数只做一件事,不要在一个函数里混杂多个业务逻辑,降低函数的耦合度。
- 优先使用箭头函数处理回调函数,避免
this指向混乱的问题,普通函数只在需要动态this的场景下使用。
// 参数使用对象传递的示例
function updateUserConfig(config) {
const { userId, userName, age } = config;
// 处理用户配置更新逻辑
}
// 调用时不需要关心参数顺序
updateUserConfig({
age: 20,
userId: 1001,
userName: '张三'
});
// 箭头函数作为回调的示例
const userList = [1, 2, 3];
const newList = userList.map(item => item * 2);
代码格式与注释规范
统一的代码格式和清晰的注释能让代码更易读,减少理解成本:
- 使用2个空格作为缩进,不要使用tab或者4个空格,保持团队内缩进统一。
- 语句结尾要添加分号,避免自动分号插入带来的潜在问题。
- 运算符两侧、逗号后面要添加一个空格,比如
let sum = a + b;,不要写成let sum=a+b;。 - 注释要写清楚代码的逻辑和用途,复杂逻辑要添加多行注释说明,不要写无意义的注释,比如
// 给a赋值这类注释没有实际价值。 - 公共函数、组件要添加文档注释,说明函数的参数、返回值、功能描述,方便其他开发者调用。
/**
* 计算商品总价
* @param {Array} goodsList - 商品列表,每个元素包含price和count属性
* @returns {number} 商品总价
*/
function calculateTotalPrice(goodsList) {
let total = 0;
// 遍历商品列表累加总价
for (const goods of goodsList) {
total += goods.price * goods.count;
}
return total;
}
错误处理与异步规范
合理的错误处理和异步代码规范能提升代码的健壮性:
- 不要忽略错误捕获,异步操作、可能出错的代码块要添加
try...catch处理,避免错误直接抛出导致程序崩溃。 - 使用Promise处理异步操作时,最后要添加
catch捕获错误,使用async/await时也要配合try...catch。 - 不要使用
throw抛出字符串类型的错误,建议抛出Error实例,包含清晰的错误信息,方便排查问题。
// 异步操作的错误处理示例
async function fetchUserData(userId) {
try {
const response = await fetch(`/api/user/${userId}`);
const data = await response.json();
return data;
} catch (error) {
console.error('获取用户信息失败:', error.message);
// 可以返回默认值或者向上抛出错误
return null;
}
}
其他注意事项
除了上述核心规范,还有一些细节需要注意:
- 不要直接修改内置对象的原型,比如不要给
Array.prototype添加自定义方法,避免和其他库的代码冲突。 - 使用严格模式,在文件或者函数的开头添加
'use strict';,避免一些不严谨的语法带来的问题。 - 及时删除不再使用的变量、函数,避免内存泄漏,定时器使用完后要记得清除。
- 避免嵌套过深的代码,比如多层if嵌套、多层回调嵌套,可以通过提前返回、拆分函数的方式简化结构。
// 提前返回简化嵌套的示例
function handleOrder(order) {
if (!order) {
return; // 提前返回,避免后续嵌套
}
if (order.status !== 'paid') {
return;
}
// 处理已支付订单的逻辑
}
JavaScript开发规范代码可读性变量命名函数设计修改时间:2026-07-09 20:30:33