Java代码规范编码规约

一、命名规范 1.【强制】 严禁在代码中的命名使用拼音缩写 反例: BaoDan[保单]/ getBaoDanInfo()[获取保单信息] 二、格式规范 1.【强制】 使用同一的代码格式模板，基于IDE自动的格式化 三、注释规范 1.【推荐】 基本的注释要求 1) 注释需要准确的反映设计思想及代码逻辑 2）公共的方法或抽象类的方法，尽可能描述清楚:输入、输出、错误处理和返回码、以及可能抛出的异常。 3) 能够描述出业务的具体含义，使得读者能够快速了解代码背后的信息。 四、方法设计 1.【推荐】 方法的长度限制方法尽量不要超过100行，需要注意的是方法长度超过8000个字节码时，将不会被JIT编译成二进制码。 五、类设计 1.【推荐】 类成员与方法的可见性最小化任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。思考:如果是一个private的方法，想删除就删除，可是一个public的service方法，或者一个public的成员变量，删除一下。例外:为了单元测试，有时也可能将访问范围扩大，此时需要加上JavaDoc说明