好的代码本身就是注释,减少不必要的注释
驼峰命名规则
大驼峰命名
类名全部使用大驼峰
ServiceDiscovery、ServiceInstance、LruCacheFactory
小驼峰命名
方法名,参数名,成员变量,局部变量
getUserInfo()、createCustomThreadPool()、setNameFormat(String nameFormat) Uservice userService;
蛇形命名法
蛇形命名格式
在蛇形命名法中,各个单词之间通过
下划线“_”连接
,比如should_get_200_status_code_when_request_is_valid
、CLIENT_CONNECT_SERVER_FAILURE
测试方法名,常量,枚举名称
适用于单词比较多的情况
串式命名法(kebab-case)
在串式命名法中,各个单词之间通过下划线“-”连接,比如dubbo-registry
。
建议项目文件夹名称使用串式命名法(kebab-case),比如 dubbo 项目的各个模块的命名。
小写命名
包名统一
使用小写
,尽量使用单个名词作为包名,各个单词通过 "." 分隔符连接,并且各个单词必须为单数。org.apache.dubbo.common.threadlocal
抽象类命名使用 Abstract 开头。
//为远程传输部分抽象出来的一个抽象类(出处:Dubbo源码)
public abstract class AbstractClient extends AbstractEndpoint implements Client {
}
异常类命名使用 Exception 结尾。
//自定义的 NoSuchMethodException(出处:Dubbo源码)
public class NoSuchMethodException extends RuntimeException {
private static final long serialVersionUID = -2725364246023268766L;
public NoSuchMethodException() {
super();
}
public NoSuchMethodException(String msg) {
super(msg);
}
}
测试类命名以它要测试的类的名称开始,以 Test 结尾。
//为 AnnotationUtils 类写的测试类(出处:Dubbo源码)
public class AnnotationUtilsTest {
......
}
细节
POJO 类中布尔类型的变量,
都不要加 is 前缀
,否则部分框架解析会引起序列化错误
如果模块、接口、类、方法
使用了设计模式
,在命名时需体现出具体模式
命名易读性规范
为了能让命名更加易懂和易读,尽量
不要缩写/简写单词
,除非这些单词已经被公认可以被这样缩写/简写。比如CustomThreadFactory
不可以被写成 ~~CustomTF
2.命名不像函数一样要尽量追求短,
可读性强的名字优先于简短的名字
,虽然可读性强的名字会比较长一点。避免无意义的命名,保证没有歧义
避免命名过长(50个字符以内)
避免使用中文
参考:https://github.com/Snailclimb/JavaGuide/blob/master/docs/system-design/naming.md