命名规则
良好的命名规则,大大增强了程序的可读性,也是程序开发中必须遵循的规范之一,具体如下:
1. 包的命名
由小写单词组成,为了保证每个包命名的唯一性,要求程序加包名称之前加唯一前缀,如:com.bjwl.number;其中bjwl就是前缀
2. 类的命名:
使用大驼峰命名规则,即每个单词的首字母均为大写;名字使用“名词性” 单词,如:课程类型类为CourseType;
抽象类命名使用 Abstract 或 Base 开头,如:AbstractCourse或BaseCourse;
异常类使用 Exception 结尾,如空指针异常:NullPointerException
枚举类加后缀Enum;如:ProcessStatusEnum;成员名称需要全大写,单词间用下划线隔开,如:UNKNOW_REASON
分层框架命名:Dao层CourseDao;controller层CourseController
service层接口为CourseService实现为CourseServiceImpl;实体为CourseEntity;DTO/VO命名规则: CourseVO、 CourseDTO,其中VO和DTO均大写;
3.接口命名
加前缀大写的“I”代表接口,如课程接口为:ICourse,形容能力的接口名加able,如:IComparable
4.方法命名
采用小驼峰规则,即单词首字母小写,其他单词首字母大写。取值类可使用get前缀,设值类可使用set前缀,如getCourseList(),保存使用Save、删除使用Delete
5.变量命名规则
采用小驼峰规则,即单词首字母小写,其他单词首字母大写,如课程:Course;一次性的临时变量,使用单个字符的变量名,通常使用i,j,k,m和n代表整型,c,d,e,它们一般用于字符型; 数组和矢量,应采用复数命名,如:Courses
6.常量命名规则
全部采用大写,单词间用下划线隔开,如:MAX_VALUE