在Android Studio中配置及使用Android代码规范神器CheckStyle

今天在项目开发过程中,接触使用到了一个新的代码规范工具CheckStyle,于是就配置的过程及使用方法进行了简单的图文总结,步骤如下:

1、首先准备一个Sayama_checkstyle.xml文件
在Android Studio中配置及使用Android代码规范神器CheckStyle
2、打开Android Studio,点击File—Settings—Plugins
在搜索框内输入checkstyle进行搜索,搜索结果如下图所示:
在Android Studio中配置及使用Android代码规范神器CheckStyle
3、选中第一个,点击Install进行下载。
在Android Studio中配置及使用Android代码规范神器CheckStyle
4、下载完成后,点击Restart IDE对Android Studio进行重启操作
在Android Studio中配置及使用Android代码规范神器CheckStyle
5、在AS重启后,再次点击File—settings,在Tools中我们看到新出来的Checkstyle,点击Checkstyle
在Android Studio中配置及使用Android代码规范神器CheckStyle我们将其中的Checkstyle version改成8.1
然后在Configuration File中点击右侧的加号,把之前准备的Sayama_checkstyle.xml文件
添加进其中。Next到底直至完成。
在Android Studio中配置及使用Android代码规范神器CheckStyle
6、到这边我们就已经在AS中完成了checkstyle的配置,接下来我们进行具体的使用。
我们看到在AS的左下角有一个CheckStyle,点击这个CheckStyle
在Android Studio中配置及使用Android代码规范神器CheckStyle点击后我们将Rules选择为Sayama.
在Android Studio中配置及使用Android代码规范神器CheckStyle
7、如下图,有一个绿色按钮,以及他下方的两个文件图标。他们分别是Check Current file,Check Module,Check Project。点击其中一个进行测试,结果就如下图所示,Check出了一堆问题,对应着进行更改解决即可。
在Android Studio中配置及使用Android代码规范神器CheckStyle