一、包名的书写规范(Package)
推荐使用公司或机构的顶级域名为包名的前缀,目的是保证各公司/机构内所使用的包名的唯一性。包名全部为小写字母,且具有实际的区分意义。
如下关于例子:
net.vschool.user
net.vschool.user.dao
net.vschool.user.action
net.vschool.user.service
二、类名的书写规范 (Class)
类名必须使用名词,如果一个类名内含多个单词,每个单词首字母大写,后续字母小写,起伏呈驼峰状,人称驼峰式命名。给类名命名时,必须保证准确、简洁且容易理解。尽量使用完整单词,避免使用缩写词(除了大家公认的)
如:StudentAnswer.java
当要区别接口类和实现类的时候,可以在类的后面加上“Impl”。
如:接口类:UserInterface.java 接口实现类:UserInterfaceImpl
三、方法的命名
参照java驼峰命名法,首字母以小写开头,每个单词首字母大写(第一个单词除外)。
实际应用
1、方法表示一种行为,它代表一种动作,最好是一个动词或者动词词组或者第一个单词为一个动词。
2、属性方法:以get/set开头,其后跟字段名称,字段名称首字母大写。如:getUserName()
3、数据层方法:只能以insert(插入),delete(删除),update(更新),select(查找),count(统计)开头,其他层方法避免以这个5个单词开头,以免造成误解。
4、服务层方法,根据方法的行为命名,只描述方法的意义,而不采用方法的目的命名。比如系统的添加新用户,用户可以前台注册,也可以管理员后台添加,方法会被重用,所以最好不要用使用register,采用add会更好写。避免使用与web层相关的方法。
5、Web层方法最好是贴近web的语言,如register,login,logout等方法。
四、变量的命名
4.1 普通变量
参照java驼峰命名法,首字母以小写开头,每个单词首字母大写(第一个单词除外)。
例如,定义一个整形变量:intDocCount,其中int表明数据类型,后面为表意的英文名,每个单词首字母大写。
4.2 静态变量
参照java驼峰命名法,全部大写
如:USER_SIZE