统一代码风格

直接复制的开源项目的统一代码风格,是目前搜到和整理到的最落地的指导文章。

统一代码风格

如果要编辑本项目,一定要统一代码风格

统一方案

本工程代码遵守阿里巴巴p3c规范,在代码开发前建议:

  • 安装阿里巴巴规约插件,用于提早发现不规范代码,具体安装方法参照:p3c,里面有eclipse,idea的安装方法
  • 安装codeStyle插件,用于格式化代码的时候符合代码规范,安装方法见:安装codeStyle插件
  • checkStyle校验,这个不用安装,mvn在编译的时候自己会调用,写在pom.xml里,用maven-pmd-plugin调用pmd-p3c规范校验

如果工作中遇到代码格式化问题,经常导致git冲突,也可以采用上面的方案

codeStyle插件安装

这里注意下,不管eclipse或者idea,都需要导入eclipse文件夹下面的配置

eclipse

  • 依次点击:Window->Preferences->Java->Code Style->Formatter->Import
  • 选择style/eclipse/codestyle.xml文件 确定
  • 默认在Active profile中选择新导入的P3C-CodeStyle,如未选择,请手动选择
  • 点击Apply完成配置
    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(统一代码风格_第1张图片
    )]

idea

  • 依次点击进入插件界面:File->Settings->Plugins,搜索 eclipse code formatter,如已有插件则不需安装,如没有,点击Search in repositories自动搜索线上插件。
    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(统一代码风格_第2张图片
    )]
  • 导入style/eclipse/codestyle.xml 这里记住用的也是eclipse里面的 点击OK
    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(统一代码风格_第3张图片
    )]
  • 依次点击进入插件界面:File->Settings->Editor->Code Style->Java->Import Scheme->Intellij IDEA code style XML,导入style/idea/codestyle.xml 这里用的是idea的配置文件
    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(统一代码风格_第4张图片
    )]
  • 完成

windows系统,代码规范校验提示乱码

这个是因为cmd默认gbk,cmd输入:CHCP 65001 在运行mvn 提示就是不会乱码了

你可能感兴趣的:(文件配置,统一代码规范)