暖流静态代码规范与代码格式化统一配置安装
概述
我们项目组人员已达一定规模,统一代码规范与风格是非常有帮助的。十分必要
静态代码规范工具
市面上一些代码静态检查工具分为 Android Studio(IDE) + VCS 和 Gradle + Git 两种,建议使用IDE形式,更加简单与直观. 个人觉得最普遍的有:google的CheckStyle插件 和 阿里团队的PMD插件。 我们推荐统一使用阿里团队的P3C,符合国情
- 阿里p3c
- CheckStyle
代码格式化工具
说白了就是统一IDE的格式化风格标准,不再以个人喜好设置。我在square团队的java-code-styles的基础上修改了一些适合我们团队的格式化风格。只要运行脚本安装即可。
其实并不复杂,就是将IDE的配置项用xml导出来,在xml修改相应的配置。再用脚本导入到其他成员的IDE之中。
下图中所示就是一个tab占多少缩进的对应配置项。
安装方法
阿里P3C安装方法
其实就是IDE插件安装,其用法都在此链接中: https://github.com/alibaba/p3c/blob/master/idea-plugin/README_cn.md
MMC自家定制的java code styles安装方法
- 下载 MMC的 android-code-style-master http://git.linghit.com:666/android_xinli/WarmFeeling/tree/master/doc/android-code-style-master
- Max Unix 环境或者类 Unix 环境,运行
install.sh
脚本即会安装配置到 IDEA。Windows 环境则运行install.bat
脚本. - 若 IntelliJ IDEA 运行中一般要重启才能生效。
- 打开 Project Settings -> Code Styles,修改为使用Schema为
MMCAndroid
配置项.
其他注意事项
- 现在有了MMCAndroid统一格式化,记得在撸代码的时候经常按一下reformat code (option + command + L) , 并在IDE 提交代码是勾选Reformat Code , Optimize imports .