设置webstorm和idea符合Alibaba规范
只格式化自己更改的代码 ctrl+Shift+Alt+L
插件建议 Alibaba Java Coding Guidelines(新版本的idea不支持,有其他同名的非官方版可代替),使用方法在此不赘述
1、设置webstorm
包含 设置两个空格缩进,去掉行尾分号,去掉最后一个逗号,以及其他前后空格需求
2、设置idea
下载xml文件(更新于2022年) 下载eclipse-codestyle
这里只导入code Style ,不影响其他设置
导入方式如下,导入后还可以切换回你原来的配置
如果是旧版的idea,需要安装Eclipse Code Formatter插件,然后选择File->Settings->Other Settings->Eclipse Code Formatter进行idea代码格式配置:将代码格式化文件eclipse-codestyle.xml,配置到插件中
新建javadoc注释
新建一个分组(避免与系统的混淆)
先填红框的这几项(注意空格以及*对齐)
方法注释必须包含 作者、邮箱、创建时间、描述、参数、返回值类
**
* @Author : 名字(不建议使用系统的名字)
* @Email : 邮箱
* @Create : $date$ $time$
* @Description :
$param$
$return$
* @throws $exception$
*/
设置作用范围,配置参数
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());
return
groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType());
配置好后的使用方法 输入/* 按Tab键 (异常那个不知道为什么没带出来 手动输入一下,如果输入错误会变成红色,如果方法没有异常,删掉*@throws
)。注意输入参数的文字描述等。
类/接口/枚举注释必须包含 作者、邮箱、创建时间、类职责描述
作用范围和参数配置方法同上
**
* @Author : 名字
* @Email : 邮箱
* @Create : $date$ $time$
* @Description :
*/
配置好后的使用方法 输入/** 按Tab键 (注意输入类描述)
TODO,这里有个特殊处理,各自用各自的TODO,方便筛选处理,webstorm和idea均适用
作用范围(我全选了,大家随意)
// todo-wyw $DATE$ $TIME$ by wuyw ,
参数设置
设置补全键,这里我用的enter,大家随意,可以延用Tab
设置TODO起作用
输入tdwyw 按enter键
筛选自己的TODO