目录
[IDEA 设置类注释模板作者、日期、描述等信息(推荐标准!)](#IDEA 设置类注释模板作者、日期、描述等信息(推荐标准!))
IDEA 设置类注释模板作者、日期、描述等信息(推荐标准!)
1、新建类的时候自动添加类注释
打开设置
1.File-->settings-->Editor-->File and Code Templates-->Files
2.在class与interface加入注释模板
/**
*@ClassName ${NAME}
*@Description TODO
*@Author xxx
*@Date ${DATE} ${TIME}
*/
类注释添加完毕,新建则会生成注释
二.方法注释
1.File-->Settings-->Editor-->Live Templates
2.新建组:命名为userDefine 新建模板:命名为*
3.在模板内加入内容:
*
* @Description
* @Date time date
param
* @return return
**/
4.选择模板的应用场景,一般选择EveryWhere-->Java即可
5.设置参数的获取方式,选择右侧的Edit variables按钮
6.多参数时要用脚本来处理,复制下面这段代码到上面的位置
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())
7.快捷键根据自己需求进行选择,设置完成
8.测试
在方法上面,先打出/* ,然后按下回车键Enter
三.属性注释
/**
* 注释内容
*/
四.方法步骤注释
//注释内容