函数参数命名怎么规范:写代码别再随便叫a、b、c了

参数名不是越短越好

很多人刚开始写函数,图省事,参数直接用 a、b、c 或者 x、y。比如写个计算折扣的函数:

function calc(x, y) {
return x * (1 - y);
}
别人看一眼完全不知道 x 是原价还是折扣率,y 又代表啥。等项目一复杂,自己过两周回来都得愣住。

用能“读得懂”的名字

参数名的核心是让人一看就明白它的用途。比如上面那个函数,改成这样就清楚多了:

function calculateDiscount(originalPrice, discountRate) {
return originalPrice * (1 - discountRate);
}
虽然名字长了点,但调用的时候不会出错,维护也轻松。就像你给文件夹起名“新建文件夹1”和“2024年报销单据”,哪个好找不用多说。

布尔参数要体现状态

如果参数是 true/false 类型,名字最好带 is、has、can 这类前缀。比如:

function showUserPanel(isLoggedIn, hasPermission) {
if (isLoggedIn && hasPermission) {
// 显示面板
}
}
要是写成 showUserPanel(status, flag),别人根本猜不到这两个值到底控制什么。

避免缩写歧义

有些人喜欢缩写,比如 usr 代替 user,temp 代替 temporaryValue。但 usr 容易看成 “user” 的错别字,temp 更是万金油,谁也不知道它临时存了个啥。不如老老实实写全称,打字多几下,省去后期 debug 半小时。

数组或对象参数要说明内容

当参数是一个列表或结构体时,名字要反映里面装的是什么。比如处理学生成绩,别写 process(data),而是:

function generateReport(studentScores, teacherFeedback) {
// ...
}
这样调用时一眼就知道该传什么数据进去,也不会把两个参数顺序搞反。

别用拼音或中英混杂

看到 getMingCheng 或 updateXinXi 这种参数名真的很头疼。中文看不懂,英文又不完整。统一用英文命名,团队协作时谁都看得明白,工具提示也更准确。

保持风格一致

如果你的项目里大家都用驼峰式命名(camelCase),就别突然来个下划线(user_name)。统一风格能让整个代码看起来像一个人写的,哪怕十个人在改。