1. 类注释模板
File-->settings-->Editor-->File and Code Templates-->Class
* 如需设置接口注释模板选择interface同理
在public class ${NAME} {}前加上下面的注释
/**
* className: ${NAME}
* description:
* author: ${USER}
* date: ${DATE} ${TIME}
* version: 1.0
*/
2. 方法注释模板
File-->Settings-->Editor-->Live Templates
点击右边的+
(1)新建组:命名为userDefine
(2)新建模板:命名为*
(3)设置生成注释的快捷键 Expand with Enter
(4)设置模板内容(Template text)-JavaDoc格式
*
*
* @author yourname
* @date $time$ $date$ $param$ $return$
**/
(5)设置模板应用场景
点击右下角change
设置将模板应用场景,一般选择EveryWhere-->Java
(6)设置参数
选择右边的Edit Variables
JavaDoc格式的需要自定义参数以及返回值的实现方式
param:
groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())
return:
groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())
(6)使用
在方法前输入/*后回车即可添加注释