JavaScript变量命名规范核心是统一、清晰、可预期,采用小驼峰法(如userName)、布尔值加is/has前缀、数组加list/items后缀、常量用全大写下划线(API_BASE_URL),禁用模糊词与非法符号。

团队开发中,JavaScript 变量命名规范的核心是统一、清晰、可预期——不是追求完美,而是让所有人一眼看懂变量用途,且不会因风格混乱引发协作摩擦。
统一采用小驼峰命名法(camelCase)
所有普通变量、函数、对象属性、方法名都用小驼峰:首单词全小写,后续单词首字母大写。
-
推荐:
userName、isModalOpen、fetchUserData、maxRetryCount -
不推荐:
username(无分隔难读)、user_name(下划线非主流)、UserName(易与类名混淆)、MAX_RETRY_COUNT(这是常量写法)
按语义加前缀或后缀,明确类型和意图
光靠拼写不够,需通过命名结构传递关键信息:
- 布尔值用 is、has、can、should 开头:
isLoading、hasPermission、canEdit - 数组/列表加 list、items、data 等后缀:
userList、orderItems(避免只叫users,无法判断是否为数组) - 回调或事件处理器加 handle 或 on:
handleSubmit、onChangeColor - 异步操作加 fetch、load、save 等动词:
fetchProfile、saveSettings
常量全大写下划线(CONSTANT_CASE)
用 const 声明、运行时不会变更的值,必须大写+下划线:
在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。
立即学习“Java免费学习笔记(深入)”;
-
推荐:
API_BASE_URL、DEFAULT_TIMEOUT、MAX_FILE_SIZE -
注意:即使值是数字或字符串,只要逻辑上是“固定配置”,就走此规则;不要混用
defaultTimeout或default_timeout
禁止使用模糊词和缩写,除非全团队公认
命名要让人不查上下文也能猜出用途:
-
避免:
data、info、temp、val、obj -
替换为:
userData、userInfo、tempPassword、userInputValue、userConfig -
缩写限制:仅允许广泛共识的,如
id、url、btn(限 DOM 变量)、ctx(限 context),禁用自造缩写如usrNm、prfl
其他硬性约束(必须写进 ESLint 规则)
这些不是建议,是项目级红线:
- 不能以数字开头:
3rdParty❌ → 改为thirdParty✅ - 不能含空格、连字符、中文或特殊符号:
user-name、用户名称、user@name都非法 - 严格区分大小写:
userId和UserID是两个变量,禁止混用 - 禁用保留字:
class、let、static、package等不可作变量名

















