JS 中变量命名规范有哪些怎么在团队中落地

梦杰同学_1406

梦杰同学_1406

2026-10-25

500人浏览

原创

js变量命名核心是语义清晰、自解释,需遵守语法底线(字母/数字/_/$开头非数)、大小写敏感、禁用关键字、小驼峰、布尔加is/has/can、常量全大写下划线、禁用模糊词;团队靠eslint、naming.md文档、code review三件套落地。

js 中变量命名规范有哪些怎么在团队中落地

JS 变量命名规范的核心不是背规则,而是让名字“自己说话”——别人看一眼就知道它存什么、在哪用、能不能改。团队落地的关键也不在强制统一,而在建立可检查、可讨论、可迭代的共识机制。

基础命名规则必须守住底线

这些是语法+协作的硬性前提,不满足就容易出错或引发歧义:

  • 只用字母、数字、下划线(_)、美元符($),且首字符不能是数字(let 1user 报错);
  • 严格区分大小写: userName、UserName、USERNAME 是三个变量;
  • 禁用关键字和保留字:比如 class、let、default、package 不能当变量名;
  • 默认用小驼峰(camelCase):如 isModalOpen、userProfileData、maxRetryCount;
  • 布尔值加 is/has/can 前缀:如 isActive、hasPermission、canEdit,一眼识别用途;
  • 常量全大写下划线:如 API_TIMEOUT_MS、DEFAULT_PAGE_SIZE,配合 const 声明;
  • 避免模糊词:不用 data、info、temp、val,优先用 userPreferences、orderStatus、retryDelayMs。

语义清晰比长度更关键

名字不是越短越好,而是“刚好够懂”。缩写只在上下文明确、团队公认时才用:

Json Repair Kit
Json Repair Kit

使用 Node.js 评估修复格式错误的 JSON,自动纠正尾随逗号、单引号、未加引号的键等常见问题,实现文件规范化。

下载
  • 当前用户姓名 → currentUserName(官方推荐),不是 name(太泛)或 curUName(自造缩写);
  • 我们所在的星球 → ourPlanetName(强调归属),不是 planet(歧义)或 earthName(硬编码,不具扩展性);
  • API 响应错误信息 → apiResponseError 比 err 或 resErr 更稳妥;
  • 若变量作用域极小(如单个 for 循环内),i、j 可接受;但函数参数或对象属性一律用完整名,如 startIndex 而非 si。

团队落地靠三件套:工具 + 文档 + 习惯

光靠口头约定很难持久,需要轻量但有效的支撑:

  • ESLint 配置固化规则:启用 camelcase、no-unused-vars、id-length(设最小长度为2)等规则,CI 中失败即阻断;
  • 命名决策文档(不是长篇大论):维护一个简短的 NAMING.md,只列高频场景示例,比如:
    ✅ 推荐:isLoading、userRoleList、MAX_RETRY_ATTEMPTS
    ❌ 避免:loading(类型不明)、roles(缺上下文)、maxRetry(单位/类型缺失)
  • Code Review 明确命名项:把“变量名是否自解释”列为必查点,新人 PR 中第一次起名不当,不直接改,而是引导提问:“如果没看上下文,这个变量你猜它存什么?”;
  • 编辑器补全友好:鼓励用稍长但结构清晰的名字(如 cartItemQuantity),现代编辑器能自动提示,反而比短名更快输入、更少出错。

特殊场景处理有章法

真实项目总有例外,关键是提前约定而不是临时发挥:

  • 第三方 API 字段映射:保留原始命名(如 api_response_code),但用别名转成内部风格:const responseCode = apiData.api_response_code;;
  • 国际化 key 或 CSS 类名:允许用中划线(user-profile-card),但 JS 变量仍走 camelCase,不混用;
  • 类型相关前缀(谨慎使用):仅在 TypeScript 缺失或强类型需求明显时考虑,如 strUsername、numTimeoutMs,但优先用类型系统或 JSDoc 注释替代。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5186

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1269

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

5124

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

980

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1916

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3625

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4733

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3120

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

988

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.3万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习