JAVA文件命名规范
1.类命名
抽象类以ABstract或者Base开头。
异常类以Exception结尾。
枚举类以Enum作为后缀。
形容能力的接口使用able作为后缀。
实现类与接口用后缀Impl区别。
数据类:表名+DO。
传输类:领域相关名+DTO。
展示类:页面名称+VO。
2.service/dao层方法命名
获取单个对象用get做前缀。
获取多个对象用list做前缀
获取统计值用count做前缀。
插入用save做前缀。
删除用remove做前缀。
修改用update做前缀。
数据库命名规范
库:应用名表:业务名称_表的作用(单数形式
主键索引:pk_字段名
唯一索引:uk_字段名
普通索引:idx_字段名
表示是否字段:is_xxxx unsigned tinyint(1.表示是,0表示否)
JUnit单元测试命名规范
1.测试类的命名定义规范
类的命名规则是:被测试的业务+Test、被测试的接口+Test、被测试的类+Test
类的名字必须由大写字母开头而其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写,如MobileBindTest。如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample。
2.测试用例的命名定义规范
test+用例操作_状态 或者 test+用例方法名称_具体测试方法
单词的约定与测试类命名同。如:testSetMobileBind_NoSkyid
比如要测试的用例是“数据库用户信息不存在时,获取Mobile绑定消息”,那么它的测试用例名称就是testSetMobileBind_NoSkyid
?比如要测试的方法是findParam,采用的是边界值方法,那么它的测试用例名称可以是testFindParam_Boundaries
3.测试程序的包名定义规范
被测试类的包名前加上“test.” 。被测试类的包名是com.wistrons.util,那么测试类的包名就是test.com.wistrons.util。
测试程序包的命名规则是:test.com.skymobi.项目名;测试公共类包的命名规则是:test.com.skymobi.common
4.变量的命名规范
第一个单词的首字母小写,其后单词的首字母大写
例如:maxValue
变量名不应以下划线或美元符号开头,尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆,即,能够指出其用途。尽量避免单个字符的变量名,除非是一次性的临时变量。
5.常量的命名规范
常量名应该都使用大写字母,下划线分割单词。例如:
MAX_VALUE
版本控制工具提交信息命名规范
第1行:提交修改内容的摘要(少于25个汉字,不用句号,使用祈使句,大写字母开始)
第2行:空行
第3行以后:修改的理由(大概36个汉字换行,正文解释是什么和为什么,而不是如何做)