checkstyle安装、配置、使用

  1. 良好的代码格式方便阅读,利于多人维护,避免格式化代码后差异太多
  2. android studio默认配置格式化后,基本满足我们的格式要求。
  3. 下面是如何安装,配置checkstyle。
  4. 部分内容参考自官方文档,目前主要是有两种范约束xml文件,分别是sun_checks.xml和google_checks.xml

android studio(intellij)中安装

  1. 要求STUDIO_JDK为jdk8以上,否则安装后无法正常使用,可以在环境变量中配置STUDIO_JDK=../jdk为studio的jdk版本
  2. 打开studio,File–>setting–>Plugins–>Marketplace,搜索checkstyle,然后安装,如下图
    checkstyle安装、配置、使用_第1张图片
  3. 打开studio,File–>setting–>Plugins–>install plugin from disk,如下图,选择官方的文件安装包
    checkstyle安装、配置、使用_第2张图片
  4. 打开studio,File–>Settings–>OtherSettings–>CheckStyle,点“+”,选中“Use a local checkstyle file”,点击Browse,导入简化版配置文件putao_checks.xml,然后只勾选刚导入的,点击OK,退出Setting
  5. 打开studio,打开java代码,右键,点击Check current file 选项,检测当前代码是否有checkstyle异常,下方checkStyle栏目会显示检测结果.

本文地址 http://blog.csdn.net/csqingchen/article/details/51896769

eclipse中安装

  1. 菜单help–>install new software,在work with后面输入栏,输入在线安装地址 http://eclipse-cs.sourceforge.net/update,安装
  2. 菜单Windows–>Preference,点击checkstyle,点击New,在Check Configuration Properties界面,type选择External Configuration File, 点击Browse,导入putao_checks.xml,配置完成点击OK.
  3. 选中刚新加的配置,点击右侧Set as Default
  4. 打开一份java代码,右键,就有checkstyle选项

本文地址 http://blog.csdn.net/csqingchen/article/details/51896769

命令行中使用

改方法使用较繁琐,版本不一样还可能会出现其他异常,不推荐使用

  1. 从官方地址或者 Maven central下载checkstyle-**-all.jar到自己的电脑
  2. 使用命令形式如下
    java -jar checkstyle-**-all.jar的绝对路径 -c putao_checks.xml的绝对路径 要检测文件的路径
    例如
    java -jar /home/chenjim/bin/checkstyle/checkstyle-6.8.1-all.jar -c /home/chenjim/bin/checkstyle/putao_checks.xml ./MainActivity.java
  3. 命令太长了,太难记,太麻烦了,可以写一个脚本文件checkstyle/checkstyle.bat,里面内容如下
    java -jar /home/chenjim/bin/checkstyle/checkstyle-6.8.1-all.jar -c /home/chenjim/bin/checkstyle/putao_checks.xml $1
    将文件加到环境变量,加上可执行权限,然后checkstyle ./MainActivity.java就行了

本文地址 http://blog.csdn.net/csqingchen/article/details/51896769

你可能感兴趣的:(checkstyle,开发工具)