Java:方法命名规范

以下是Java方法命名的核心规范及最佳实践:

  1. 基本规则
  • 必须使用驼峰式命名(camelCase)
  • 必须以字母或下划线开头(推荐字母)
  • 不能使用Java关键字(如class/void等)
  1. 命名结构
  • 动词开头 + 名词描述(动宾结构)
    正确示例:calculateTax(), getUserName()
    错误示例:tax(), nameOfUser()
  1. 常用前缀规范
  • 获取类:get + 属性名(getSalary()
  • 判断类:is/has + 条件(isValid()
  • 设置类:set + 属性名(setAddress()
  • 转换类:to + 目标类型(toString()
  • 动作类:do/process + 操作(doPayment()
  1. 特殊方法规范
  • 测试方法:should + 预期行为(shouldThrowException()
  • 构造方法:与类名完全一致(User(String name)
  • 静态工厂:of/valueOfLocalDate.of(2022,12,31)
  1. 长度控制
  • 理想长度:3-15个单词
  • 超长时建议拆分方法(如generateAndSendReport()拆分为generateReport()+sendReport()
  1. 禁止行为
  • 避免拼音缩写(如cxUser()查询用户)
  • 避免无意义命名(如method1()
  • 避免与类名重复(如User.user()
  1. 行业惯例
  • CRUD操作:createXxx()/findXxx()/updateXxx()/deleteXxx()
  • 回调方法:on + 事件(onClick()
  • 监听器:add/remove + Listener(addActionListener()

示例对比:

// 好的命名
public void calculateMonthlyRevenue() {...}
public boolean isEligibleForDiscount() {...}

// 差的命名
public void calRev() {...}  // 缩写不明确
public void check() {...}   // 动词缺少宾语

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值