【Alibaba编码规范】参照AlibabaJava开发手册记录一些IDEA相关设置方式

Alibaba编码规范,可以参照修改IDEA中的设置。
IDEA版本2021.1

后续继续补充中。。。

【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式,不要使用
Windows 格式。
【强制】 采用 4 个空格缩进, 禁止使用 Tab 字符。
说明: 如使用 Tab 缩进, 必须设置 1 个 Tab 为 4 个空格。 IDEA 设置 Tab 为 4 个空格时, 请勿勾选 Use tab character;
【强制】 所有的类都必须添加创建者和创建日期。
说明: 在设置模板时, 注意 IDEA 的@author 为${USER}, 而 eclipse 的@author 为${user}, 大小写有区别, 而日期的设置统一为 yyyy/MM/dd 的格式。
【】接口方法javadoc规范

File Encodings 文件编码

【强制】IDE 的 text file encoding 设置为 UTF-8;

修改编码字符集
File–>Settings–>Editor–>FileEncodings
在这里插入图片描述

文件换行符

【强制】 IDE 中文件的换行符使用 Unix 格式,不要使用Windows 格式。

修改换行符
File–>Settings–>Editor–>Code Style
在这里插入图片描述

Tab及缩进 空格数

【强制】 采用 4 个空格缩进, 禁止使用 Tab 字符。

修改Tab占多少Space,并设置缩进使用多少Space。(一般来说这里不用手动改,默认是这样的,只是为了方便后续修改)
在这里插入图片描述

添加文件头模板

【强制】 所有的类都必须添加创建者和创建日期。
说明: 在设置模板时, 注意 IDEA 的@author 为${USER}, 而 eclipse 的@author 为${user}, 大小写有区别, 而日期的设置统一为 yyyy/MM/dd 的格式。

在这里插入图片描述

添加方法javadoc注释模板

在这里插入图片描述
添加的模板如下:

*
$params$
* @return $return$
* @exception $exception$
* @author YourName
* @date $date$
*/

设置变量:
在这里插入图片描述
关于author,date可以设置user(),date()。也可以设置Default value。
其中param的默认值为:

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result+='* @param ' + params[i] + ' '}else{result+='\\n' + ' * @param ' + params[i] + ' '}}; return result;}", methodParameters());

只设置了参数和返回值的效果:
在这里插入图片描述

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值