JavaScript / TypeScript / 系统课时
变量命名与代码规范
变量命名与代码规范
本篇解决 JavaScript 开发中变量名称难理解、容易冲突和违反规范的问题。学习后可以按照语言规则和团队习惯编写更容易维护的变量名。
学习目标
- 掌握 JavaScript 标识符规则和限制
- 理解驼峰命名与语义化命名方式
- 识别常见变量命名错误并改进代码可读性
理解变量名的基本规则
JavaScript 中变量名属于标识符,需要满足语言定义的规则。变量名可以包含字母、数字、下划线和美元符号,但不能以数字开头,也不能使用保留关键字。
js
let userName = "Alice";
let user2 = "Bob";
let _count = 10;
let $price = 99;
console.log(userName, user2, _count, $price);预期输出
text
Alice Bob 10 99下面的写法会导致语法错误。
js
let 2user = "Alice";
let function = "test";预期结果
text
SyntaxError: Unexpected token实际开发中虽然 $ 和 _ 合法,但通常只在特定场景使用,例如库源码或特殊约定,不建议普通业务变量大量采用。
使用驼峰命名表达含义
JavaScript 社区通常采用小驼峰命名法,即第一个单词小写,后续单词首字母大写。
例如:
js
const firstName = "Alice";
const orderTotalPrice = 199;
const isUserLoggedIn = true;这些名称直接表达变量用途,比下面的缩写更容易维护。
| 不推荐 | 推荐 | 原因 |
|---|---|---|
n |
userName |
含义不明确 |
amt |
orderAmount |
避免缩写歧义 |
flag |
isEnabled |
表达布尔含义 |
使用语义化名称减少理解成本
好的变量名应该描述保存的数据,而不是描述代码实现过程。例如保存用户数量时,count 只能表达数量概念,而 activeUserCount 可以说明统计对象。
布尔变量通常使用 is、has、can 等前缀,让读取代码时更接近自然语言。
js
const hasPermission = true;
const canEditProfile = false;
if (hasPermission && canEditProfile) {
console.log("allow edit");
}预期输出
text
因为条件结果为 false,代码块不会执行,没有控制台输出。
避免常见命名错误
变量命名不仅影响当前代码,也影响后续维护。常见问题包括:
- 使用没有业务含义的单字符名称。
- 混用下划线、拼音和英文导致风格不统一。
- 使用过长名称,把完整业务描述堆积到变量中。
- 使用关键字或容易误解的缩写。
命名不需要越长越好,而应该在准确表达含义和保持简洁之间取得平衡。例如 customerOrderPaymentStatus 可以表达业务含义,但如果上下文已经明确是订单模块,paymentStatus 可能更合适。
在团队项目中保持一致
个人代码可以依靠习惯维护,但多人协作需要统一规则。实际项目通常会通过 ESLint 等工具检查命名风格、禁止未使用变量和限制潜在错误。
变量命名的目标不是追求复杂,而是让其他开发者无需额外阅读上下文,也能快速理解数据代表什么。清晰命名会直接降低调试和维护成本。
按自己的节奏,确认真正理解。