阿里代码规范检查工具的安装使用以及阿里代码格式化
一、阿里代码规范检查工具的安装使用
详细的插件安装过程(包括eclipse和idea),请参考下面的文档
参考文档 https://www.cnblogs.com/chenjfblog/p/7685579.html
该idea版本的插件如果没法在线安装,插件离线版本下载地址献上:
https://download.csdn.net/download/suyuaidan/10486245
二、代码格式化文件的导入
阿里的代码规范检查工具就安装好了,下面开始介绍格式化文件的使用
1、eclipse 格式化设置
Eclipse一般常用的可以导入两处 *.xml 格式的模板,一个是常用的注释格式模板,另一个是代码格式化时用的模板,导入方法如下:
假设: 【代码注释格式模板】.xml 是代码注释格式模板 【代码格式化模板】.xml 是代码格式化时的自定义模板
导入格式化代码模板:
第一步 进入导入模板界面和选择需要导入的模板
点 Formatter,在上部有个Import按钮,这个导入的是 格式代码时用的模板,即 【代码格式化模板】.xml
第二步:导入注释模板
导入方式:打开 Window——Preferences
Java——Code Style 下面点 Code Templates,在右侧 有个 Import 按钮,这个 导入的是 注释模板配置文件,即 【代码注释格式模板】.xml
2、idea导入代码格式化文件
由于格式化配置文件是基于Eclipse的,所以idea需要安装一个格式化插件
该插件如果没法在线安装,插件离线版本下载地址献上:
https://download.csdn.net/download/hh775313602/9950672
idea安装格式化插件
代码格式化相应的文档
阿里的格式化文件下载地址:https://github.com/alibaba/p3c
其中格式化文件是这个,下载到本地
导入java格式化文件
idea好像是没有导入Eclipse注释配置文件的方法,因此,这里介绍下手动设置类的注释格式:
导入完成后,设置idea的类注释,如下图
代码片如下
/**
* 应用模块名称<p>
* 代码描述<p>
* Copyright: Copyright (C) ${YEAR} XXX, Inc. All rights reserved. <p>
* Company: XXX科技有限公司<p>
* @author ${USER}
* @since ${DATE} ${TIME}
*/
效果:
这样idea的类注释也设置好了
后记:
代码格式化更多详细的设置可以看这里:
http://wiki.jikexueyuan.com/project/intellij-idea-tutorial/file-templates-introduce.html
上一篇: H5移动端弹幕动画实现
下一篇: gradle+shell实现自动系统签名