函数参数命名,应该做到:简洁、语义清晰、符合上下文。不同类型的函数,参数命名习惯略有不同。以下是通用的命名规范和示例:
✅ 一、通用函数参数命名建议
| 参数作用 | 常用命名 | 说明 |
|---|---|---|
| 配置对象 | options, config, params | 表示可选项、请求参数等 |
| 回调函数 | callback, cb, onSuccess | 表示回调(推荐语义命名) |
| 数据本体 | data, info, payload | 通常用于业务数据 |
| 错误对象 | err, error | 错误处理 |
| DOM 元素 | el, element, node | HTML/小程序/React元素引用 |
| 数组 | list, items, arr | 表示一组数据 |
| 下标/索引 | i, index | 常用于循环 |
| 状态值/布尔值 | flag, isValid, visible | 布尔命名用 is/has 等开头 |
| 数值/数目 | count, num, total | 表示数量、计数等 |
✅ 二、按常见函数类型举例
示例 1:请求类函数
|
1 2 3 4 |
function fetchData(params) { // params: 请求参数对象 } |
示例 2:组件传值
|
1 2 3 4 |
function handleClick(event) { // event: 事件对象(常见于 wxml, React) } |
示例 3:回调函数
|
1 2 3 4 5 |
function doSomething(data, onSuccess, onFail) { // onSuccess: 成功回调 // onFail: 失败回调 } |
示例 4:校验函数
|
1 2 3 4 |
function isUserValid(user) { // user: 用户信息对象 } |
✅ 三、布尔型参数命名规范(建议语义化)
| 正确写法 | 含义 |
|---|---|
isReady | 是否准备好 |
hasPermission | 是否有权限 |
shouldRetry | 是否应该重试 |
enableLogging | 是否启用日志(启用功能) |
❌ 避免使用无语义的 flag, bool, type = 1
✅ 四、命名风格建议
- 使用驼峰命名法:
isLogin,userData,onSubmit - 避免拼音:❌
zhangsanData,shifouVisible - 避免单字母乱用(除非在 map、循环中临时变量)
🎯 总结
函数参数命名要做到:能看懂、不含糊、有语义。