Android Studio中CodeStyle模板的配置

在团队开发中,统一代码规范和风格是提高团队效率的必要工作。AS提供了 Code Style 配置方法,便于为开发团队定制一套自己的 Code Style Scheme 。

一、CodeStyle配置

Code Style 文件导入编辑

进入 AS 的 Preferences 中,到下图所示选项

Android Studio中CodeStyle模板的配置

上图中的 SquareAndroid 即是 Square 公司提供的 Android 代码风格配置文件 这里获取,建议可以在他们的基础上进行一些自定义修改。

将下载好的文件中 SquareAndroid.xml,导入 AS

Android Studio中CodeStyle模板的配置

然后结合自己团队定义的代码风格进行一些调整,将调整好的 Code Style 文件导出。就可以在团队内进行全面使用了。

配置完统一编码风格后,编写代码的时候开发人员各自按自己的习惯高效率进行编写。编写完成后只需要将编写的文件进行格式化,快捷键为:CMD+OPTION+L(macOS),CTRL+ALT+L(Win)

注:本文 AS 版本为 2.3.3,老版本的配置方式可能有点差别。

二、使用 CheckStyle-IDEA 插件检视代码

在 AS 中下载并安装 CheckStyle-IDEA插件。

Android Studio中CodeStyle模板的配置

下载一个代码检视 xml 文档, 推荐使用 google 的,google_checks.xml
可以根据自己团队在之前定义好的代码规范进行相应调整。具体调整参考 Checkstyle 的相关配置文档

接下来将自定义好的 Checkstyle 文档导入到 AS 作为插件的配置文件。

Android Studio中CodeStyle模板的配置

然后,就可以在任意的java文件中进行代码规范检视了。

Android Studio中CodeStyle模板的配置

全文参考于 AndroidStudio 配置 Code Style 并安装检查插件 原文中还提到结合 AS 提供的版本控制工具 GIT插件 实现在提交代码的时候对修改的文件进行自动格式化。