2012-12-11|2867阅|作者：小蜜锋|举报 摘要:所有文件，变量统一采用英文单词表示。尽量避免简写和缩写。 一、 java类 java类根据java规范采用驼峰标示，java类首字母大写，类名中的各个单词首字母都大写。 Java类代表现实世界的一个事物，类名词最好是一个名词。最好采用现实的名称。如员工用Employee，而不是E
所有文件，变量统一采用英文单词表示。尽量避免简写和缩写。
一、 java类
java类根据java规范采用驼峰标示，java类首字母大写，类名中的各个单词首字母都大写。
Java类代表现实世界的一个事物，类名词最好是一个名词。最好采用现实的名称。如员工用Employee，而不是Employ避免歧义。最好不是用缩写empl等。
应用软件中经常应用分层，每一层的类的名称尽量带上该层后缀。
推荐实体类没有后缀名。
数据层使用SQLMapper后缀。
数据层查询参数为Param
服务层使用Service
Web层使用Packager
Web层form表单后缀为Form
比如员工模块，分别为Employee(实体)，EmployeeSQLMapper(数据层)，EmployeeService(服务层)，EmployeePackager(web层)
常用英文名称(最好能整理一份常用词汇词典)
员工:employee
部门:department
。。。。
二、 字段
根据java驼峰标示命名法，java字段以首字母以小写开头，每个单词首字母大写（第一个单词除外）。
字段表示现实中一个事物的属性在类中的名称，最好用名词。字段名称应采用最精确的单词，尽量采用一个单词。没有必要把类名挂在字段前面，如employee的id字段，直接可以用id，不用使用employeeId，如果出现两个字段可能产生歧义，可以增加描述性单词来区分。
字段命名最好能看词识意。
三、 方法
方法表示一种行为，它代表一种动作，最好是一个动词或者动词词组或者第一个单词为一个动词。
属性方法，get/set开头，其后跟字段名称，字段名称首字母大写。
数据层方法，只能以insert（插入）,delete（删除）,update（更新）,select（查找）,count（统计）开头，其他层方法避免以这个5个单词开头，以免造成误解。
服务层方法，根据方法的行为命名，只描述方法的意义，而不采用方法的目的命名。比如系统的添加新用户，用户可以前台注册，也可以管理员后台添加，方法会被重用，所以最好不要用使用register，采用add会更好写。避免使用与web层相关的方法。
Web层方法最好是贴近web的语言，如register，login，logout等方法。
四、 变量
变量是一方法中重要的元素，一个贴切的名称，能让这段代码优雅百倍（夸张一下）。变量名首字母小写。
变量属于名称，避免用采用其他词性。
采用名称要能代表在方法中的意义。如果员工列表：
最好是使用List employees或则employeeList而不是去使用List list或则更糟糕的List l，如果应用了List employees和Map employees可以分别使用employeeList和employeeMap。
自定义类型的变量可以采用本身的名称，把首字母改为小写。
五、 Xml文件名
Xml命名采用与类名相似的方法，采用首字母大写的驼峰标示。
Ibatas映射文件:namespace名称为该模块实体类的名称，首字母大写，typealias采用该类simple name。resultMap和sql名称采用首字母小写的命名规则，方法名称与数据层方法名称一致。
Form和FormItem文件名才用首字母大写的驼峰标示。Form名称也使用首字母大写的格式。Form中的item名称使用与form表单类的属性名称。采用驼峰标示（最好不使用_分隔）
Action文件名称使用首字母大写，文件package和action name字段采用所有字母小写的格式。
六、 URL命名
url路径名称统一采用小写（所有字母都用小写）,用get方法提交的参数名和url路径名一样使用小写。
文章评论
初级程序员
共1 条评论 1/1页
