检查代码风格

当项目成员逐渐增多的时候,代码的风格就出现了很大的问题,这对于合并代码来时是非常痛苦的一件事。如何让大家的代码风格保持一致呢,除了比如阿里的开发手册那样约定的某些规则之外,我们也可以安装插件让编辑器自动检查。

IDEA中安装插件:

  • comman + ,打开settings,找到左侧导航Plugins,搜索checkStyle,点击安装,找到checksytle.xml的文件,打开即可安装。

  • 在settings的左侧,找到Other Settings,点开,可以到已经开启的插件了,checkstyle也在里面。点击checkstyle,进入checkstyle的配置,在Configuration File中点击+,选择checkstyle.xml文件的路径即可。

code style 修改两处

1.每行最多100字符

  • idea设置中,Editor->Code Style=>Right margin:将120改为100

2.最多同一个包多少次引用之后引入*

  • idea设置中,Editor->Code Style->Java=>
    1. Class count to use import with “*”:将4改为100
    2. Names count to use static import with “*”:将5改为100

check style 说明

1.checkstyle检查分为三个基本,红色error为必须修改,灰色warning为特殊情况
不修改(入pojo中的隐藏字段),蓝色info为不做检查要求,尽量修改。

xml配置

打开链接,点击另存即可。

codestyle.xml
checkstyle.xml