基本要求:
代码要采用逐级缩进“{”放在上一行末尾,“}”在下一行独立一行,一行只写一条语句,所有命名不能以数字开头,不能使用Java关键字。可以包含的特殊符号有"_","$",所有标点符号均为英文状态。
包的命名规范
包名应全部是小写字母,包名中不能出现下划线,并且第一个字母不能是数字,不能以点开头或结尾。
与业务相关的包的命名格式为:
<根目录>.<一级目录companyname>.<二级目录projectname>.<三级目录modulename>
与业务无关的包的命名格式为:
<根目录>.<一级目录companyname>.common.<三级目录modulename> //所有项目通用
<根目录>.<一级目录companyname>.<二级目录projectname>.common //单个项目所有模块通用
类、接口命名规范
类和接口的名称应是一个名词,采用帕斯卡命名法,接口的名称应以大写字母 I 开头,每个类和接口必须添加说明。
方法命名规范
方法名采用驼峰命名法,应是一个动词或动名结构,每个方法前必须说明包括:参数说明,返回值说明,异常说明。
变量命名规范
变量名采用驼峰命名法,应简短且有意义,即,能够指出其用途。除非是一次性的临时变量,应尽量避免单个字符的变量名。
常量命名规范
常量的命名应全部用大写,单词间用下划线隔开。
表达式
所有的算术、逻辑表达式的每一项运算都需要加圆括号。