《java基础》请给我一个合适的名称

事情的开端

阳光明媚的午后,你发现旁边的同事,突然打开了某翻译软件。时而眉头紧皱,时而喜上眉梢,此时请你不要打断他,他应该是在思考一个非常严峻的事情,“我到底应该给它起个什么通俗易懂的名字那?”不知道各位同僚有没有为此事烦恼?

在这里插入图片描述

命名的重要性

一个好的名称可以让人更快的了解你写的方法或类的大概作用,一个不合格的名称也会让人误入歧途。我还在学习java的时候对命名就没有什么特别深的概念,总感觉一个名字能有多重要。当时我的类中充满了A1都Z9,我却对此不以为然,感觉与其浪费时间起名,不如多敲几行代码。代码少的时候还好,可当数量增多时,就会突然发现,写着写着突然忘记了这个所谓的A1它到底代表了什么。这时不得不往上查找。真是捡了芝麻丢了西瓜。所以大家一定要重视命名!

在这里插入图片描述

命名的建议

1. 代码命名时不能使用以下划线(__)和美元符($)开始和结束。
2. 禁止使用英语加拼音或直接使用中文命名。
3. 包名都是小写,单词之间用点(.)隔开。
4. 类名使用UpperCamelCase(驼峰)命名法。
5. 方法名、参数名、成员变量、局部变量使用lowerCamelCase(除第一个单词外其它首字母大写)命名法。
6. 常亮名称全部大写,单词之间用下划线隔开。
7. 抽象类的类名使用Abstract或者Base开头。异常类的类名使用Exception结尾。测试类的类名用要测试的类的名称开头,以Test结尾。
8. POJO中的布尔类型的变量,不可加is前缀。可能在部分框架解析时出现序列化异常。
9. 避免子父类的成员变量或不同代码块的局部变量使用完全相同的名称,会降低可读性。
10. 杜绝使用不规范的缩写。
11. 接口的实现类使用Impl结尾。
12. 枚举类名以Enum后缀,成员名称使用全大写,单词间用下划线隔开。
13. Service/DAO层方法命名规约:
    a、获取单个对象的方法用get做前缀。获取多个对象的方法用list做前缀,复词结尾。
    b、获取统计值得方法用count做前缀。
    c、插入的方法用save/insert做前缀。
    d、删除的方法用remove/delete做前缀。
    e、修改的方法用update做前缀。
14、领域模型命名:数据对象以表名开始,DO结尾。数据传输对象以DTO结尾。展示对象以VO结尾。

注:命名的建议来自阿里的《java开发手册》,推荐大家可以阅读一下!

不积跬步,无以至千里;不积小流,无以成江海!

猜你喜欢

转载自blog.csdn.net/first_M/article/details/105740257