遵守普遍接受的命名规范

本文是Effective Java 学习笔记
当你简化你的生活,宇宙的法律将更加简便;孤独不会孤独,贫穷不会贫穷,也不虚弱无力。——亨利大卫梭罗(梭罗)

第56条:遵守普遍接受的命名规范

包的名称:


包的名称应该是层次壮的,用句号分隔每部分。每个部分都包括小写字母和数字(很少使用数字)。任何将在你的组织之外使用包,其名称都应该以你的组织的Internet域名开头,并且顶级域名放在前面,例如:edu.cmu com.sun
包名称的其余部分应该包括一个或者多个描述该包的组成部分。这些组成部分
应该比较简短,通常不超过8个字符。鼓励使用有意义的缩写形式,例如,使用
utils而不是utilities。只取首字母缩写形似也是可以接受的,例如awt。
每个组成部分通常都应该由一个单词或者一个缩写词组成。

类和接口的名称


包括枚举和注解类型的名称,都应该包括一个或者多个单词没个单词都首字母大写,例如Timer和TimerTask.
除非是一个首字母和通用的缩写,比如max和min。
多个单词情况例如:HttpUrl

方法和域的名称与接口命名


首字母大写 :例如remove、ensureCapacity
常量域:包括一个或多个大写的单词,中间用下划线隔开,例如
private static final int GET_ASSOCIATIONS_ACTION = 1;
常量域是唯一一个推荐使用下划线的情形。

类型参数名称通常由单个字母组成。这个字母通常是以下五种类型之一;
T表示任意类型的,E表示集合元素类型,KV表示映射的键和值类型,X表示异常。任何类型的序列可以是TUV或者T1T2T3
表 字面惯用例子

项目价格
package org.litepal;
类或接口LitePalBase、AverageCallback
方法或者域onFinish、select、order
常量域GET_ASSOCIATIONS_ACTION、GET_ASSOCIATION_INFO_ACTION、字母”l”(还包括大写字母”O”)尽量不要和数字混用

局部变量 | getMethodName
类型参数 | T、U、V、T1、T2、T3
执行某个动作方法通常用动词或者动词短语来命名,例如append和drawimage
对于返回boolean值的方法,其名词往往以单词“is”开头,后面跟名词或者名短语或者具有形容词功能的单词和短语,例如isDigit、isProbalePrime、
isEmpty、isEnable、hasSiblings。
转换类型的方法、返回不同的类型独立对象方法,通常被称为toType,例如toString和toArray。
返回视图的方法通常被称为asType。例如asList。
返回一个与被调对象同值的基本类型的方法,通常被称为typeValue,例如intValue。
静态工厂的常用名称为valueOf、of、getInstance、newInstance、getType和NewType

辅助工具

阿里巴巴Java代码规约


github地址https://github.com/alibaba/p3c

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值