类头注释
在阿里巴巴Java开发手册里明确写到所有的类都必须添加创建者和创建日期
1. 不同类文件分别设置注释
首先打开Idea设置(File→Settings→Editor→Filea and Code Templates)
分别为Class、Interface、Enum等设置头部注释
2. 全部类文件设置注释(推荐)
如果不想分别设置,可以进行所有文件设置
注释模板
/**
* @description TODO
* @author ${USER}
* @date ${DATE} ${TIME}
*/
方法注释
- 打开File→Editor→Live Templates
- 点击右上角的+,选择Template Group双击,然后弹出一个窗口,随便添加一个名字,我这里是Test,然后确定。
- 点击刚才新建的Group,依旧是点击右上角+,选择Live Template。其中"Abbreviation":缩写(之后打这个缩写,按“tab”就会自动出现注释,因为我们习惯用/**注释,所有这里填 *),Description描述,Templete text注释模板,设置如下。
然后我们点击Edit variables进行赋值,其中param为groovy脚本
-
选择应用范围,选择java
-
方法模板代码
*
$param$ * @return $returns$
* @description TODO
* @author $user$
* @date $date$ $time$
*/
- 方法参数groovy脚本
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == '' || params[i] == ' ') return result; result+=' * @param '+ params[i] + '\\n';}; return result;", methodParameters())