暖流靜態(tài)代碼規(guī)范與代碼格式化統(tǒng)一配置安裝
概述
我們項目組人員已達(dá)一定規(guī)模坯沪，統(tǒng)一代碼規(guī)范與風(fēng)格是非常有幫助的。十分必要
靜態(tài)代碼規(guī)范工具
市面上一些代碼靜態(tài)檢查工具分為 Android Studio(IDE) + VCS 和 Gradle + Git 兩種拂募，建議使用IDE形式腰埂，更加簡單與直觀. 個人覺得最普遍的有：google的CheckStyle插件 和 阿里團(tuán)隊的PMD插件耕肩。 我們推薦統(tǒng)一使用阿里團(tuán)隊的P3C八孝，符合國情
- 阿里p3c
- CheckStyle
代碼格式化工具
說白了就是統(tǒng)一IDE的格式化風(fēng)格標(biāo)準(zhǔn)，不再以個人喜好設(shè)置灰瞻。我在square團(tuán)隊的java-code-styles的基礎(chǔ)上修改了一些適合我們團(tuán)隊的格式化風(fēng)格腥例。只要運(yùn)行腳本安裝即可辅甥。
其實并不復(fù)雜，就是將IDE的配置項用xml導(dǎo)出來燎竖，在xml修改相應(yīng)的配置璃弄。再用腳本導(dǎo)入到其他成員的IDE之中。
下圖中所示就是一個tab占多少縮進(jìn)的對應(yīng)配置項底瓣。
MMC IDE Code Style配置
MMC IDE Code Style在XML相應(yīng)的位置
安裝方法
阿里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 環(huán)境或者類 Unix 環(huán)境蕉陋，運(yùn)行
install.sh腳本即會安裝配置到 IDEA捐凭。Windows 環(huán)境則運(yùn)行install.bat腳本. - 若 IntelliJ IDEA 運(yùn)行中一般要重啟才能生效。
- 打開 Project Settings -> Code Styles凳鬓，修改為使用Schema為
MMCAndroid配置項.
其他注意事項
- 現(xiàn)在有了MMCAndroid統(tǒng)一格式化茁肠，記得在擼代碼的時候經(jīng)常按一下reformat code (option + command + L) , 并在IDE 提交代碼是勾選Reformat Code , Optimize imports .
IDE 提交代碼勾選
