团队协作中,代码规范是十分重要的,我们可以通过配置 Android Studio 的 Code Style 来按一定标准去格式化我们的代码,并且配合 CheckStyle-IDEA 这个插件去检查格式化不能更改的一些 ‘不规范’ 代码。
1.配置 Java Code Style
我们团队在 Java Code Style 上采用了 Square 公司的标准。首先需要下载一个 xml 文件。
下载地址: Square Android Code Style
导入下载的xml文件
File -> Setting -> Editor -> Code Style -> Java -> 然后按图上标注数字依次选择导入。这样在 上方 Scheme 那里就可以下拉 选择我们刚才导入SquareAndroid 标准去 reformat 代码了。
当然你也可以按自己的标准去做一些更改,比如你希望注解都单独成行,可以在 Wrapping and Braces的 TAB 项中将 对应 annotations 后面改成 Wrap always。
注解总是单独成一行
XML中也可以进行修改,比如我希望 View 标签后面不要再多出一行
Layout Files Wrap always
2.安装 CheckStyle-IDEA
这里还是要先下载一个 xml 文件 , 我们团队使用了 Google 的检查规范。
下载地址: google_checks.xml
然后搜索安装 CheckStyle-IDEA 插件
安装后在 Setting -> Other Settings 里可以看到 Checkstyle的选项,导入我们刚才下载的文件
导入 google_checks.xml
图里的 gsd_check_style.xml 就是对应我们刚才下载的文件,这里我们团队做了一些修改。导入并应用后,在类文件中右键鼠标会有 Check Current File 这个选项,帮助我们检查该文件中不符合规范的地方,你就可以做相应的修改了。
Check Current File
3.提交代码时自动格式化
有时我们提交代码前,可能许多文件忘记了进行格式化,这样提交之后,同事 update 的时候就会有许多 蓝色或绿色提示的 change (使用AS里的版本控制) ,为了在提交前保证对代码进行格式化,可以在 Commit 弹出的框框中 勾选下图中的两项 来让 Android Studio 自动帮我们格式化代码
Reformat code