Java编码风格规范指南

一、命名规范1.【强制】不得采用拼音缩写作为命名，例如：BaoDan[保单]或getBaoDanInfo()[获取保单信息]。二、格式规范1.【强制】应当统一使用代码格式模板，并依赖IDE进行自动格式化。三、注释规范1.【推荐】基本注释要求：确切反映设计思想和代码逻辑；对于公共方法或抽象类的方法，应清晰描述输入、输出、错误处理、返回码以及可能抛出的异常；应能够准确描述业务含义，方便读者快速理解代码背后信息。四、方法设计1.【推荐】方法长度应限制在不超过100行，需要注意当方法长度超过8000个字节码时，将无法被JIT编译成二进制码。五、类设计1.【推荐】最小化类成员与方法的可见性。严格控制任何类、方法、参数、变量的访问范围，避免过于广泛的访问范围，以利于模块解耦。需要思考：相比于可以直接删除的private方法，对于public的service方法或成员变量的删除可能更为复杂。例外情况是为了进行单元测试，有时可能需要扩大访问范围，此时需要加上JavaDoc的说明。