文章目录
一、项目命名/包命名/虚拟目录/资源路径二、Java 代码命名三、属性文件 properties 命名四、xml文件命名五、jsp文件命名六、html文件命名七、js文件命名八、css文件命名九、图片文件命名十、数据库命名十一、html 标签的属性值命名规则总结一、项目命名/包命名/虚拟目录/资源路径
项目名称使用英文,全部字母小写,单词之间使用连接线-
。如 :student-management
包名称使用英文,全部字母小写,通常都是一个单词,词性是名词,如果需要多个单词,单词之间使用下划线。
虚拟目录,使用英文,全部字母小写,如果需要多个单词,单词之间使用下划线。
资源路径,使用英文,全部字母小写,如果需要多个单词,单词之间使用下划线。
二、Java 代码命名
1、包名:包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,例如:com.htlwk.qpw.util
。
2、类名:PascalCase 命名法,帕斯卡命名法,又称之为 UpperCamelCase,大驼峰式命名法 ,每一个单词的首字母都大写,类名如果有复数含义,类名可以使用复数形式,例如:SimpleDataFormat
、MessageUtils
3、方法名:Camel 命名法,骆驼式命名法,又称之为 lowerCamelCase,小驼峰式命名法。混合使用大小写字母,即多个单词的情况下,第一个单词首字母小写,其余单词首字母均大写。方法名一般采用动词+名词或动词表示,如append()
、getName()
、printStackTrace()
等。
4、变量名(对象名):和方法名一样的规范,一般采用名词或形容词+名词的形式表示。
5、属性名:和变量名一样的规范,一般采用名词或形容词+名词的形式表示。如name
、dbClassName
、dbUser
、dbPassword
、dbUrl
等。
6、常量名:下划线命名法,UnderScoreCase,全部大写,单词之间加下划线,例如:MAX_PRIORITY
。
三、属性文件 properties 命名
全部小写,标准缩写大写,单词之间加下划线
例如:errors_zh_CN.properties,hibernate_test.properties
四、xml文件命名
全部小写,单词之间加连接号-
,我建议使用下划线_
五、jsp文件命名
全部小写,单词之间加连接号-
,我建议使用下划线_
六、html文件命名
全部小写,单词之间加连接号-
,我建议使用下划线_
七、js文件命名
全部小写,单词之间加连接号-
,我建议使用下划线_
八、css文件命名
全部小写,单词之间加连接号-
,我建议使用下划线_
九、图片文件命名
全部小写,单词之间加连接号-
,我建议使用下划线_
十、数据库命名
mysql数据表名:Camel命名法,单词之间加下划线,全部小写。控制在30个字符内。举例:country_language
mysql数据库名:同表名一样
mysql表字段名:同表名一样
oracle数据表名:Camel命名法,单词之间加下划线,全部大写。举例:COUNTRY_LANGUAGE
oracle数据库名:同表名一样
oracle表字段名:同表名一样
主键约束命名:约束类型+表名+字段名。举例:pk_dept_deptno
视图命名:v+表名。例如:v_student_major
索引命名:idx+表名+列名。例如:idx_student_name
十一、html 标签的属性值命名规则
html 标签的 id 属性值和 class 属性值的命名规则:单词之间使用连接号。
例如:div-right
也有很多项目使用下划线,参考大厂的开发习惯,使用连接号比较多。
name 属性值的命名规则:首字母小写,后面的单词首字母大写。
总结
1、文件名称中什么时候使用连接号-
,什么时候使用下划线_
呢?
答:目录的名称中单词之间通常使用连接号-
隔开,所以你会发现工程名、模块名、包名(jar/rar/zip 等)基本都是在单词之间使用-
隔开。而文件的名称中单词之间通常使用下划线_
隔开,比方说脚本文件(js/sql 等)、标记文件(xml/html 等)、样式表单文件(css)、属性文件(Properties)等在命名时,单词之间都是使用下划线_
隔开。