知用网
白蓝主题五 · 清爽阅读
首页  > 电脑技巧

函数参数命名怎么规范 日常维护方法与实用案例

函数参数命名的基本原则

写代码时,函数参数的名字不是随便起的。名字起得好,别人一看就明白这个参数是干啥的,维护起来也省心。比如你写个计算折扣的函数,参数叫 pricediscountRate,比叫 ab 强太多了。

参数名要能表达它的用途,避免使用模糊词,比如 datainfovalue 这类名字,等于没说。如果是个用户信息对象,就叫 userInfo;如果是订单编号,就叫 orderId,清楚明了。

使用驼峰命名法

在 JavaScript、Java、C# 等语言中,普遍采用驼峰命名法(camelCase)。第一个单词小写,后续单词首字母大写。比如:

function createUser(userName, userEmail, userAge) {
// ...
}

这样看起来统一,读起来也顺。别混用下划线或全大写,除非项目本身有特殊规范

布尔参数要表达状态

如果参数是布尔类型,名字最好以 ishascan 开头,让人一眼看出是开关性质的控制项。

function showNotification(isVisible, hasSound, canClose) {
// ...
}

isVisibleshow 更明确,尤其是当函数调用时传的是变量而不是字面量的时候。

避免缩写和简称

别为了省几个字母乱缩写。比如把 config 写成 cfg,把 message 写成 msg,虽然常见但不推荐。团队里新人可能看不懂,时间久了自己都得想半天。

除非是广泛接受的缩写,比如 id 代表 identifierurl 代表 uniform resource locator,这种可以接受。

参数顺序也有讲究

通常把最重要的参数放前面,控制选项往后排。比如:

function resizeImage(image, width, height, preserveRatio = true) {
// ...
}

这里 image 是核心数据,必须传;widthheight 是主要设置;preserveRatio 是可选行为,放在最后。

用具体名称代替泛化词

别动不动就用 itemlistobj。如果是购物车里的商品,就叫 cartItem;如果是用户列表,就叫 userList。越具体越好理解。

举个例子:

function processOrder(orderData) {
// 处理订单逻辑
}

这里的 orderData 虽然比 data 好一点,但如果改成 orderInfo 或直接 order,反而更自然。

考虑调用时的可读性

写函数时要想想别人怎么调用它。比如下面这行:

sendRequest('get', '/api/user', true);

三个参数都是字面量,根本看不出第三个 true 是啥意思。改成带名字的参数(在支持命名参数的语言里)或者用对象封装:

sendRequest({
method: 'get',
url: '/api/user',
withCredentials: true
});

这样一目了然,后期加参数也不影响原有调用。

保持一致性最重要

一个项目里,命名风格要统一。如果你看到别人都用 userId,你就别写成 user_iduid。团队协作中,一致的命名比“多正确”更重要。

有些公司会用 ESLint 或 TSLint 强制检查命名规则,提前设好规则,大家照着来就行。