JS 中常量命名大写规范怎么在团队中统一

雨丽酱_1131

雨丽酱_1131

2026-10-14

301人浏览

原创

js常量命名须用全大写加下划线(upper_snake_case),仅限真正不变、全局可见、有业务含义的固定值,需通过eslint id-match规则强制校验,并在文档、ci流程及code review中落实。

js 中常量命名大写规范怎么在团队中统一

JS 中常量命名统一用全大写加下划线(UPPER_SNAKE_CASE),比如 MAX_RETRY_COUNT、API_BASE_URL,这是团队可读性与维护性的基础共识,不是风格偏好,而是语义契约。

明确常量的定义边界

先统一“什么才算常量”——不是所有 const 声明的变量都该大写。只有真正不会变、全局可见、有业务含义的固定值才适用:

  • 环境配置项:const PRODUCTION = 'prod' → 改为 const ENVIRONMENT_PRODUCTION = 'prod'
  • 数学/协议常量:const PI = 3.14159 → const PI = 3.14159(小写也可接受,但团队需约定;更推荐 const MATH_PI)
  • 避免误标:const user = getUser() 是不可变引用,但值可变,不满足常量语义,不应大写

用 ESLint 强制校验

光靠约定容易遗忘,必须工具化。在 .eslintrc.js 中启用 id-match 规则,精准约束常量命名:

Wjs Uploading Video
Wjs Uploading Video

将一个或多个视频上传至YouTube。当用户想“上传到YouTube”“发YouTube”“批量上传”“upload to YouTube”“post videos to YouTube”或发布到YouTube时使用此技能。

下载
  • 匹配所有 const 声明的顶层变量(不含函数参数、for 循环变量)
  • 正则要求:全大写 + 下划线 + 至少一个下划线(排除单个单词如 DEBUG,鼓励语义完整如 ENABLE_DEBUG_LOG)
  • 示例配置片段:
```js
rules: {
  "id-match": ["error", "^[A-Z][A-Z0-9_]*[A-Z0-9]$"]
}
```

配套文档与新人引导

把规范落到可执行层面,避免“看过即忘”:

  • 在项目 CONTRIBUTING.md 里写清楚:“常量必须使用 UPPER_SNAKE_CASE,且需通过 eslint --fix 自动修正”
  • 提供正反例对比表格,贴在团队知识库首页(例如:DEFAULT_TIMEOUT ✅ vs defaultTimeout ❌)
  • 新成员首次 PR 时,由 Code Reviewer 主动检查常量命名,作为必过项

和 Prettier 协同避坑

Prettier 不管命名,但会干扰 ESLint 的修复流程。确保二者不打架:

  • 禁用 Prettier 对变量名的格式化(它默认不碰名字,但某些插件可能越界)
  • 在 .prettierrc 中明确不干预标识符:"semi": false、"singleQuote": true 等只管格式,不碰命名
  • CI 流程中,先跑 eslint --fix,再跑 prettier --write,顺序不能反

相关专题

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

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

2023.06.20

4826

5

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

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

2023.07.04

1189

3

js四舍五入
js四舍五入

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

2023.07.04

4744

6

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

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

2023.09.01

940

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1856

5

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

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

2023.09.04

3425

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4433

6

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

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

2023.09.20

2920

5

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

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

2023.09.20

928

7

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.2万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习