IDEA与eclipse的统一化编码

为什么需要统一?

因为编码习惯的问题,每个人对于命名、代码的写法都不一样,导致项目大了之后,代码风格千奇百样,这就给后期维护带来一些成本。

当前项目中用IDEA与eclipse的人数各占一半,因为两种工具的不同,代码提交版本后其他人再去格式化,则会出现许多冲突,这也给开发带来了不少的麻烦。

因此出现了两种统一化的需求:编码规范的统一、代码格式的统一。

有什么解决方案?

为此,alibaba出了一个解决方案:p3c,项目地址: https://github.com/alibaba/p3c

对于编码规范:p3c提供了IDEA与eclipse的插件,插件共同遵循 阿里巴巴Java规范,在编码阶段进行校验、在代码审核时可对编码风格进行统一。

对于代码格式:p3c提供了统一的eclipse的格式化文件,IDEA通过安装插件( Eclipse Code Formatter)也可以使用eclipse格式化文件,这样IDEA也就保持了代码格式的统一。

相关文件的下载

代码检查插件: https://github.com/alibaba/p3c/tree/master/idea-plugin

代码检查插件使用说明: https://github.com/alibaba/p3c/blob/master/idea-plugin/README_cn.md

eclipse代码格式文件: https://github.com/alibaba/p3c/tree/master/p3c-formatter

Eclipse Code Formatter: https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter

插件的安装

自行google吧

IDEA导入eclipse格式化文件

前提:先安装好IDEA插件: Eclipse Code Formatter

插件安装完毕后,打开设置,按照如下配置,选择eclipse-codestyle.xml即可

IDEA使用eclipse的格式化文件

注意点

格式化的时候,如果发现代码imports发生变更,可以取消格式化时优化imports

方式:快捷键 ctrl + alt + shift + L,打开格式化选项,把Optimize Imports前面的勾去除

IDEA使用eclipse的格式化文件

TIPS

格式化快捷键:ctrl + alt + L

如果觉得每次写代码都要格式化一下很麻烦,可以在提交的时候把下面的选项打上,这样每次提交都会进行代码格式化与代码规范检查

提交时选择代码检查与格式化

如果还是觉得很麻烦,可以安装自动格式化插件:save actions,下载地址:https://plugins.jetbrains.com/plugin/7642-save-actions

这样文件保存时可自动格式化等等

观云

本博客所有文章均为独立创作。 原创不易,转载请注明来源并保留原文链接,转载自观云 | yeas.fun

You may also like...

发表评论

电子邮件地址不会被公开。 必填项已用*标注