java编码规范

java编码规范

1. 编码规范的作用

• 软件的生命周期中，几乎80%的花费用于维护
  编码规范有利于程序的可读性，可以让程序员尽快的理解和理解代码

2. 注释

• 源文件开头注释，包括类名、版本信息、日期、作者，如下：
  idea开发环境配置类注释模板settings-File and Code Templates-class

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
    /**
        *@ClassName ${NAME}
        *@Author ${USER}
        *@Date ${DATE} ${TIME}
        *@version V1.0
    **/
    public class ${NAME} {
    }

• 方法注释
  每个方法都写明作用和入参，使用/**+Enter的方式注释
• 实体类属性注释
  每个属性备注含义，状态码需要详细说明每个状态码的含义，使用/**+Enter注释
• 判断条件注释
  编码业务中有判断条件的地方，建议添加注释

3. 包和引入语句

• 引入需要的类和包时，只引入自己需要的包或者类，减少以.*结尾的引入

4. 声明和命名

• 变量的声明按公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。
• 方法的声明应该按照功能去分类，目的是便于阅读和理解代码
• 变量和方法声明使用驼峰命名法，请勿使用**_**的形式

5. 代码缩进排版

• 4个空格常被作为缩进排版的一个单位。而制表符Tab一般代表的是8个空格。idea配置Tab为4个空格的方式，settings - > editor -> code style -> java,配置indent为4，其他默认。其他编译环境自行配置。

6. 行的长度与换行

• 行的长度以idea为例，建议一行不超过120字符
• 换行以逗号、操作符之前，新的行与上一行的表达式开始位置对齐

7. if-else和switch-case

• 当判断分支不超过3个的时候使用if-else，超过时使用switch-case.
• switch-case使用时，当一个case执行之后没有break，需要说明注释

8. boolean类型的判断

• 不要写if(*** == true)，使用if(***),减少代码量，使代码看起来简洁易读。

9. null与" "、常量的判断

• 已知的放在前面，如：if(null == *** ) 或者 if(" ".equals(***))

10. api接口尽量不要组装视图，需要组装视图的请在controller中完成
11. 常量变量名称需要大写加下划线组成，如CLASS_NAME。
12. 项目中请创建常量类，工具类，禁止魔法数字0、1等出现。
13. 勿重复编写代码，创建共有继承类或者接口。