函数参数命名规范

函数参数命名,应该做到:简洁、语义清晰、符合上下文。不同类型的函数,参数命名习惯略有不同。以下是通用的命名规范和示例:


✅ 一、通用函数参数命名建议

参数作用常用命名说明
配置对象options, config, params表示可选项、请求参数等
回调函数callback, cb, onSuccess表示回调(推荐语义命名)
数据本体data, info, payload通常用于业务数据
错误对象err, error错误处理
DOM 元素el, element, nodeHTML/小程序/React元素引用
数组list, items, arr表示一组数据
下标/索引i, index常用于循环
状态值/布尔值flag, isValid, visible布尔命名用 is/has 等开头
数值/数目count, num, total表示数量、计数等

✅ 二、按常见函数类型举例

示例 1:请求类函数

示例 2:组件传值

示例 3:回调函数

示例 4:校验函数


✅ 三、布尔型参数命名规范(建议语义化)

正确写法含义
isReady是否准备好
hasPermission是否有权限
shouldRetry是否应该重试
enableLogging是否启用日志(启用功能)

❌ 避免使用无语义的 flag, bool, type = 1


✅ 四、命名风格建议

  • 使用驼峰命名法isLogin, userData, onSubmit
  • 避免拼音:❌ zhangsanData, shifouVisible
  • 避免单字母乱用(除非在 map、循环中临时变量)

🎯 总结

函数参数命名要做到:能看懂、不含糊、有语义