遇到的问题:
java项目中用了 checkstyle maven插件 对代码进行强制检查
但是项目是mybatis的框架 mapper 和 mapperImpl
及实体都是通过mybatis插件自动生成的代码 检查时出现一堆问题 上千条错误 导致修改不完的规范 。
解决方案
1.在项目中 会有一个 checkstyle.xml 这个文件是用来控制检查哪些东西
2.想要过滤掉某个类不检查 如:mapper dto 等 找到项目中的 suppressions.xml 这个文件 在其中增加如下代码
<?xml version="1.0"?> <!DOCTYPE suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
<!-- checks 代表你想过滤掉哪种检查 此文是过滤掉了 Javadoc 注释 ->
<!-- files 代表你想对项目中的哪个类进行过来 ->
<suppress checks="Javadoc" files="com.mapper"/>
<suppress checks="Javadoc" files="com.dto"/>
</suppressions>
注:其中 checks想过滤掉哪种检查 请查看 checkstyle.xml规则