背景
项目的代码时间时间很长,经过太多人手,代码的规范性堪忧,目前存在较多的比较自由的「代码规范」,这非常不利于项目的维护,代码可读性也不够高。 分析现有项目的代码的情况,输出的『定制化规范』文档,用于提高代码的可读性和可维护性。
收益
对于个人:帮助团队写「正确」的代码,提升编程能力。
团队内部:统一项目的编码风格,降低维护『非自己模块』的成本
对外部门:交付更加稳定的产品,并降低后期的维护难度
开发工具配置规范
工欲善其事,必先利其器。
-
推荐使用最新的稳定版本的 Android Studio 进行开发
-
编码格式必须统一为UTF-8
-
编辑完 .java、.kt、.xml 等文件后必须格式化(需要在设置好以下几点的前提下,Reformat Code 的必要性,一定需要保证 IDE 配置一致为前提,尽可能贴切于 Android Studio 默认。强烈建议对于比较长的老代码局部格式化,不全局格式化)
每行字符数不得超过100字符(IDE默认) 设置 Editor -> Code Style
Java代码格式规则(默认设置)
- 全部设置为单类导入