3.2 建议
建议1 包名采用域后缀倒置的加上自定义的包名,采用小写字母,都应该以com.dg11185开头(不包括一些特殊原因)。
说明:除特殊原因包结构都必须以com.dg11185开头。
格式:
com.dg11185.项目名.模块名称
示例:
package com.11185.oa.exam; // OA考试模块包名
建议2 通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。
说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。
建议3 常用组件类的命名以组件名加上组件类型名结尾。
示例:
数据访问接口 类型,命名以Dao结尾——ExamDao
数据接口实现 类型,命名以DaoImpl结尾——ExamDaoImpl
Service接口 类型,建议命名以Service结尾——ExamService
Service接口实现 类型,建议命名以ServiceImpl结尾——ExamServiceImpl
建议4 如果函数名超过15 个字母,可采用以去掉元音字母的方法或者以行业内约定俗成的缩写方式缩写函数名。
示例:
public String getCustomerInformation(); // 改为 getCustomerInfo()
建议5 准确地确定成员函数的存取控制符号:只是该类内部调用的函数使用 private 属性,继承类可以使用的使用protected属性,同包类可以调用的使用默认属性(不加属性控制符号),对外公开的函数使用public属性。
示例:
protected void getUserName() {
...
}
private void calculateRate() {
...
}
建议6 含有集合意义的属性命名,尽量包含其复数的意义。
示例: customers, orderItems