1、代码模板:Code Templates设置
现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范。俗话说约定优于配置,但是在执行过程中往往发现效果不是很好(主要是指编码规范这一方面)。所以我们不得不采取一些措施来协助我们统一项目开发人员的编码风格。主要包括三个方面:设置Code Templates、Eclipse formatter、Checkstyle,本篇主要介绍如何设置Code Templates,具体步骤如下:
配置类注释:https://blog.youkuaiyun.com/newCheng/article/details/98883684
配置方法注釋:https://www.jianshu.com/p/2b17c3879879
2、代码检查:Checkstyle配置或Java代码规范检查工具p3c
CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要,但是枯燥的任务中解脱出来。CheckStyle检验的主要内容包括:Javadoc注释、命名约定、标题、Import语句、体积大小、空白、修饰符、块、代码问题、类设计、混合检查。Checkstyle的配置。具体步骤如下:
https://blog.youkuaiyun.com/Mollychin/article/details/79443813
阿里巴巴的Java代码规范检查工具p3c, 作用类似于CheckStyle, 是《阿里巴巴Java开发手册》的有效补充, 形成了Java代码规范的闭环。
源码地址: https://github.com/alibaba/p3c
具体步骤如下:
https://github.com/alibaba/p3c/tree/master/idea-plugin
3、代码格式化:IDEA 安装Code Formatter 插件
1、打开Setting的Plugins,查找Eclipse Code Formatter插件,进行安装。如图:
安装成功后重启
2、启用插件,配置XML文件,使用阿里的XML
https://github.com/alibaba/p3c/blob/master/p3c-formatter/eclipse-codetemplate.xml
配置好文件后,就可使用了,格式化快捷键:Ctrl+Alt+l