Java开发常用命名规范
Java开发常用命名规范
挑几个重点:
一、类和接口的首字母及任何任何中间单词的首字母必须是大写。
接口可以带 "I" 前缀或者 "able"、"ible" 、"er"等后缀。推荐接口命名为: I + 模块名 + 业务名称 + Service后缀。实现接口的类文件命名为为 :模块名 + 业务名称 + ServiceImpl后缀。
二、方法的命名应采用完整的英文描述符,大小写混合使用。
所有中间单词的第一个字母大写。方法名称的第一个单词通常采用一个有强烈动作色彩的动词。取值类使用 get,设置值使用 set,判断类使用 is(has),保存使用 save,删除使用 delete,查询使用 query。例如: getName(), setName(), isLogon()等方法。
三、包名一般以项目或模块名命名,少用缩写和长名,一律小写。
基本包: cn.tcl,所有包、文件都从属于此包。包名按如下规则组成: 【基本包】 .【项目名】 .【模块名】 .【子模块名】 …如:cn.tcl.uiodf.actions。不得将类直接定义在基本包下,所有项目中的类、接口等都当定义在各自的项目和模块的包中。
四、变量和参数
对不易清除识别出该变量类型的变量应使用类型缩写作为其前缀,如字符串使用 strXXX,布尔型使用 isXXX, hasXXX 等。除了第一个单词外的其他单词首字母均为大写。对私有实例变量可使用“ _”作为前缀,但在其存取方法中则应该将其前缀去掉。