Java一般命名规范

一、项目名称

最好用英文,所有单词全部用小写,如testjavaproject、studentmanagement等,当然也也可以用中文,如“学生管理系统”等。

 

二、Java project中相关命名

1、包名

包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词,最好用域名反过来写,不会冲突。如com.cnblogs.sun99bk.myutil等。

另外需要注意的是包名最好统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。

2、类名

类名使用 UpperCamelCase风格,必须遵从驼峰形式,即每个单词首字母均大写,且public类名应与所在项目名保持一致。

3、方法名、对象名和变量名

方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase风格,即必须遵从驼峰形式除第一个单词首字母小写外(若只能一个单词,就全部小写),其余单词首字母均大写。方法名采用动词+名词或动词表示,如append()、getName()等。

4、属性名

和对象命名方法相同,采用名词或形容词+名词的形式表示,如name、dbClassName、dbUser、dbPassword、dbUrl等。

5、常量

常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长,如MAX_STOCK_COUNT 等。

 

三、属性文件.properties定义变量命名

object.a_b_c格式,全部小写,其中object是宿主,a_b_c多个单词下划线分开。

例如:

hibernate.cache.use_second_level_cache,

hibernate.cache.provider_class,

hibernate.cache.provider_configuration_file_resource_path等等

 

四、xml文件命名

全部小写,-符号是其xml的用途说明,类似applicationContext属习惯命名。

比如springmvc-servlet.xml、workdesk-manager.xml、workdesk-servlet.xml、applicationContext-basic.xml等。

xml里的内容多个字符间以-隔开,比如param-name,filter-mapping等。

 

五、普通文件命名

如jsp,js,img等和Java普通变量规范相同。

 

六、属性文件properties

以下划线隔开:errors_zh_CN.properties,hibernate_test.properties

 

七、数据库命名

表、字段命名全部大写,多个单词以_隔开。

 

posted on 2019-11-13 20:47  SUN99  阅读(1665)  评论(0编辑  收藏  举报

导航