自动代码规范检查工具Checkstyle

【插件】自动代码规范检查工具Checkstyle

前言

Sky代码评审，代码风格需要按照公司的规范，借助 IDE 插件CheckStyle开源代码分析工具，检测代码的规范性，修改配置文件，使其满足Sky要求代码规范。

1. CheckStyle简介

Checkstyle会在代码开发过程中，检查代码规范，一般检查的内容包括：

Javadoc注释
命名约定
标题
Import
大小
空白
修饰符
代码
类设计

2. CheckStyle IDE 安装与使用

2.1 Eclipse安装与使用

2.1.1 Eclipse CheckStyle插件在线安装

Help -> Install New Software -> Add
-> CheckStyle -> http://eclipse-cs.sourceforge.net/update
-> OK -> [√]CheckStyle

2.1.2 Eclipse CheckStyle 插件配置

Window -> Preferences -> Checkstyle

2.1.3 Eclipse CheckStyle使用

需要分析的代码右键 -> CheckStyle -> Check Code With Style

2.2 AndroidStudio 安装与使用

2.2.1 Android Studio CheckStyle插件在线安装

File -> Settings -> Plugins -> Browse repositories -> 搜索CheckStyle-IDEA -> Install

2.2.2 Android Studio CheckStyle 插件配置

settings -> Other Settings -> CheckStyle - > +

2.2.3 Android Studio CheckStyle使用

AndroidStudio 的控制面板会多一个 CheckStyle

CheckStyle配置文件