Java开发中的命名规范
Java开发中的命名规范
一.命名规则
所有命名规则必须遵循以下规则:
1)名称只能由字母、数字、下划线、$符号组成
2)不能以数字开头
3)名称不能使用JAVA中的关键字。
4)坚决不允许出现中文及拼音命名。
5)见名知意,比如我要定义一个学生类,应该是public class Person{ },而不是public class P{ }。
二.java中的包、接口、类、方法、属性的命名规范
(1)包名一律小写,使用小写字母如com.xxx.util,不要com.xxx.Util;单词间不要用字符隔开,比如com.xxx.uti.sqlutil,而不要 com.xxx.util.sql_util。
(2)类的命名,使用驼峰式命名的规范,类的名字必须由大写字母开头而单词中的其他字母均为小写,比如类名Person;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如PersonTest。由于类是设计用来代表对象的,所以在命名类时应尽量选择名词。
(3)接口的命名规则与类的命名规则一致,可以在接口实现类的后面加上Imp以区分接口实现类与普通类,比如接口名为UserInfoInterface的实现类的类名可以取为UserInfoInterfaceImp。
(4)对于方法或属性的命名, 一个单词的时候全部小写,多个单词的话除第一个单词首字母小写,其他单词首字母都大写。比如方法名getAge(),属性变量名age、name等。
(5) 对于常量的命名,常量名如果只有一个单词则需要所有字母大写,多个单词的话所有字母都需要大写,单词之间用_隔开,比如:PI , STUDENT_MAX_AGE;
总结: 上面列出的这些原则都不是硬性规定,你可以按照自己的想法去命名。按照上述规则对包、类、方法、属性、接口、对象的命名是为了提高开发过程中代码的可读性,同时提升团队间的沟通与协作开发的效率,你可以按照自己的想法来,但那样的代码可读性很差,写代码并不是一个人的事,当今世界是一个讲究团队合作的世界,个人能力终究不可能拼过团队,如果拼过了那么我相信你一定是万中无一的练武奇才。要把一些好的东西养成一种习惯,有时候习惯是真的可以让你避免很多不必要的麻烦。
命名中见名知意是都是所有的基础,如果你命名的变量等不能见名之意,过段时间你连自己写了什么都看不懂。对了有些可能会说我可以注释啊。注释这种东西很重要,但为什么要浪费在一些不必要的开销中去呢。
参考博客:
https://blog.csdn.net/weixin_30575925/article/details/114029771
https://blog.csdn.net/pan_ye/article/details/79461958?spm=1001.2101.3001.6650.5&utm_medium=distribute.pc_relevant.none-task-blog-2%7Edefault%7ECTRLIST%7ERate-5.pc_relevant_antiscanv2&depth_1-utm_source=distribute.pc_relevant.none-task-blog-2%7Edefault%7ECTRLIST%7ERate-5.pc_relevant_antiscanv2&utm_relevant_index=10