您的位置 首页 java

软帝学院教你java命名规范法则

在我们在刚开始学习 java 的时候,给包、类、方法等命名的时候总是取名不规范,大多都是随便取的,对于一个专业的程序员来说。命名规范化也是必不可少的。命名规范的话能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。增加代码的易读性,可读性。

一、包(全部小写)

包名全部小写,但它不同的项目类型:
1.个体项目(indi ): 如:indi.发起者名.项目名.模块名.……

2.个人项目(pers): 如:pers.个人名.项目名.模块名.……

3.私有项目(priv ): 如:priv.个人名.项目名.模块名.……

4.团队项目(team): 如:team.团队名.项目名.模块名.……

5.公司项目( com / cn / net / org / edu): 如下:
包名为“com.公司名.项目名.模块名.……”。

二、类(帕斯卡命名法)

1.Java类名通常以大写字母开头,如果类名称由多个单词组成,则每个单词的首字母均应为大 写例如UserManager;

2.如果类名称中 包含单词缩写,则这个所写词的每个字母均应大写, 例如DOMDemo。

3. 还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类时应尽量 选择名词,如:Person(名词)Chinese(形容词)

4.POJO类(也就是实体类entity)
命名规范:具有含义的名字,如果有多个单词,每个单词头字母大写。一般和数据库的表照应。
例如:user_info表 则POJO类为UserInfo.

5.接口类
命名规范:业务逻辑接口实现类的命名以POJO名称来制定,并且以大写字母”I”开头,如果有多个单词,每个单词头字母大写
例如:IUserInfo

6.接口实现类
命名规范:业务逻辑接口实现类的命名以POJO名称来制定,将实现的接口名称的首字母”I”去掉,以”Impl作为结尾”,如果有多个单词,每个单词头字母大写。
例如:UserInfoImpl

三、方法(驼峰命名)

1.首字母小写,其他单词首字母大写,如:getName();

2.使用完整的描述来准确描述方法名,看到方法名就该知道这个方法的功能,例如:getNameByIdFrom表名() 一看就知道是通过id 从数据库中获取name

3. 尽量不去使用连接符 _

4.方法名应该是一个动词+名词,例如getName();

5.前缀问题
1:类的获取方法(有返回值的方法)的方法名一般加前缀get,如:getName();
2:类的布尔型判断方法一般以is为前缀,如isTrue();
3:类的设置方法加前缀set,如setName();
4:一般方法,使用完整的英文描述说明方法功能,以单词开头,如:openFile();

四、方法参数

1.使用有特定意义的词定义方法参数 ,如果可能的话使用与被赋值变量相同的名字;
如果参数需要区分和 局部变量 不重名的情况,则可以考虑加上Param
例如:userNameParam
2.首字母小写,其他单词首字母大写

五、普通变量(驼峰命名+前缀)
1.采用驼峰命名;

2.变量名要尽量简短 ,并且可以顾名思义,避免使用a,b,c等;

3.避免相似或只在大小写上有区别 ,例如:flag和Flag,避免同时使用;

4.循环计数变量使用i,j,k

5.前缀问题:
1:可以在变量名前加2到3个字母的前缀表示变量的数据类型,例如:strClassName或者classNameStr (以此表示String型)、intStudentAge或者studentAgeInt (表示int型)等等;

2:可以通过加前缀区分 全局变量 和局部变量,用g_表示全局变量,如g_strClassName。鉴 于全局变量难以维护,应该尽少用全局变量。

五、 静态变量 (全部大写,常加下划线)

1.全部大写,单词间用”_”连接,例如 static int THREAD_FLAG
其他规则参照普通变量的规则2,3,5

六、常量 (全部大写,常加下划线)

1.全部大写,单词间用”_”连接;
2.常量本身要用有意义的单词定义;

七、所有命名规则必须遵循以下规则:

1.名称只能由字母、数字、下划线、$符号组成
2.命名时不能以数字开头
3.在命名是绝对不能出现Java关键字
4.绝对不允许在命名时出现中文
5.尽可能的少用拼音性的命名

文章来源:智云一二三科技

文章标题:软帝学院教你java命名规范法则

文章地址:https://www.zhihuclub.com/186919.shtml

关于作者: 智云科技

热门文章

网站地图