CheckStyle入门总结

CheckStyle入门总结

工具：Idea 2018

安装

1. 打开左上角下拉菜单File

2. 选择Settings

3. 选择Plugins
   

4. 在Marketplace搜索 Checkstyle-idea

5. 

6. 选择Install 即可安装（我这里已安装，如下图）

7. 

8. 安装完成，直接重启编译器

使用

1. 打开需要检测的代码（使用sunCheck）

2. 右击菜单，点击Check Current File

3. 

4. 右击检查完成后，下方出现新模块，CheckStyle（红色为Error、黄色warning、蓝色information）

5. 

6. 如上图所示：缺少package-info.java，原因是包名上未提供包级的文档

//原代码
package com.ioliver.sys.controller;
//修改后的代码

//=======================================================================

/**
 * MenuController菜单的controller<br>
 * @Author oliver
 * @Date 9:21 2020/9/28
 * @since 1.8 标记是在哪个特定版本开始添加进来的
 * @version 1.0
 */
package com.ioliver.sys.controller;

8. 未知标签：‘Author’ 该注释写的位置不对，标签也不对，删除即可

9. //下列注释需要全部删除
   /**
    * @Author chengpunan
    * @Description //TODO oliver
    * @Date 9:19 2020/9/28
    * @Param
    * @return
    **/
   @Controller("/sys/menu")
   @AllArgsConstructor
   public class MenuController extends BaseController{
   }
   

10. ‘{’前应有空格

11. //原代码
    public class MenuController extends BaseController{
    //修改后的
    public class MenuController extends BaseController {
    

12. 22：5缺少JavaDoc

13. //原代码
    @Autowired
    MenuService menuService;
    //修改后
    /**
    * @return
    **/
    @Autowired
    MenuService menuService;
    

14. service应为private

15. //原代码
    MenuService menuService;
    //修改后
    private MenuService menuService;
    

16. 剩余四个直接贴代码

17. //原代码
    @GetMapping()
    String menu(Model model){
       return "sys/menu/menu" ;
    }
    //修改后
    /**
     * @Param [model]
     * @return java.lang.String
    **/
    @GetMapping()
    String menu(final Model model) {
       return "sys/menu/menu";
    }
    

总结：

以上就是CheckSytle的初使用和基本问题解决。