在写代码的过程中,我们为了业务需要快速迭代,快速开发,但是一个不规范的代码会让代码的易读性,可复用性,可维护性都大打折扣。一个公司如果想长久发展,而不是写了一次业务便不再变更,规范代码是非常重要的。
阿里前几年出了一份编码规约,里面涵盖了从数据库,代码编写,模块划分等多个方面的规范。
一、编码规约示例
下面就几条规约示例展示如下:
【推荐】循环体中的语句要考量性能,以下操作尽量移至循环体外处理,如定义对象、变量、获取数据库连接,进行不必要的 try-catch 操作(这个 try-catch 是否可以移至循环体外)。
【强制】所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。
说明:对子类的实现要求,或者调用注意事项,请一并说明。
【强制】日志文件至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。
【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。
说明:新增代码及时补充单元测试,如果新增代码影响了原有单元测试,请及时修正。
强制表示