Android Studio 的checkStyle的使用

  • A+
所属分类:Android工具
在开发中,我们需要不仅仅是个人的超强的能力(学习能力、解决问题能力等),我们也需要团队合作能力,我们要明白,我们的成功来自于我们的团队(一个英雄是很难自靠自己的能力来创造一个时代的)。今天我们就介绍一种,在团队开发中遵守某些编码规范的工具—-CheckStyle。 CheckStyle主要的功能就是实时检测,代码的规范(Code Style)是否符合我们规定的一个模板,如定义的静态常量是大写,局部参数以m开头,函数名字不超过20个字等。当发现这些不符合这些规范时,它就报一个警告或者错误等提示。

参考:
* CheckStyle的官网
* 华为的配置,可以自己改,不一定适合你

接下来讲使用吧!

1.翻墙打开,Android Studio按照下图,安装一下控件。

2.配置gradle,我直接给出我的配置吧。我配置在项目下的gradle里面了。
配置如下,方便复制:

apply plugin: 'checkstyle'

checkstyle {
    configFile rootProject.file('checkstyle.xml')
    toolVersion '6.19'
    ignoreFailures false
    showViolations true
}

task('checkstyle', type: Checkstyle) {
    source 'src/main/java'
    include '**/*.java'
    classpath = files()
}

具体的配置位置,如图:

3.安装完毕,从这里下载华为的配置checkStyle配置,然后放到你的项目中,你可以放在系统的文件夹下

4.把你的xml配置到checkStyle关联起来 设置如图所示,按那个加号,直接选择你的checkStyle.xml的文件的位置,确定就可以了。需要给它取一个名字,啥名字都可以。

5.从IDE 下面可以看到我们的插件,然后扫描整个项目,就会给你提示,还有其它功能,我慢慢发现再补充。


avatar