1、命名规范
基本原则:
1)采用英文全称进行命名;
2)保持各层级名称基本统一;
3)命名英文单词用全称,避免用简称。
1.1 包命名规范
包名称必须全部用小写。
命名方式:com.域名.项目名称.项目模块.系统分层
如:com.example.ordering.java.dao
com.example.ordering.java.controller
1.2 类命名规范
类名以英文单词取名,使用大驼峰式命名法,首字母大写,多个英文单词以大写字母间隔,尽量避免使用缩写;类名中不允许‘_’、‘-’等特殊符号。
1.3 属性命名规范
a.定义属性的位置,在类定义的开始,按照public,protected,package,private顺序放置。
b.尽量用相同含义英文单词表示如:username。第一个字母小写,中间单词的第一个字母大写。不要用_或&等符号作为第一个字母。单字符的变量名一般只用于生命期非常短暂的变量。如:i,j,k,m,n一般用于int。如果变量是集合,则变量名应用复数,即以小写s结尾 。
c.常量属性:一律大写,单词间使用_分隔。例如:MAX_SIZE
1.4 方法命名规范
方法命名采用“动作+属性” 的方法。并且,动作以小写字母开始,属性以大写字母开始。常用的动作有:is、get、set、save、add、del等。示例:getName()
2.编码规范
2.1 类及方法注释
2.1.1 类的注释
目的:主要标注该类的作用,对类进行简单描述;记录类的作者和类的创建日期
/**
*