设置类注释模板
选择File→Settings→Editor→File and Code Templates→Includes→File Header
模板代码
/**
*@author 你的名字
*@date ${DATE} ${TIME}
*@Description TODO
*/
效果
设置方法注释模板
File -> Settings-> Editor -> LiveTemplates
新建
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为*m快捷键用Enter,则生成方式为/**m+Enter)
使用的模板(与截图中的代码有些出入,唉,我们太懒了,懒得再去重新去截一张图,正确的代码在这,直接复制过去就ok了)
*
* @Description TODO
* @Date $date$ $time$
$param$
* @return $return$
*/
设置模板的应用场景
如果曾经修改过,则显示为change而不是define
这一步和下一步不可颠倒,否则下一步将获取不到方法
设置参数的获取方式
选择每个参数对应的获取方法(在下拉选择框中选择即可)
多参数时要用脚本来处理,复制下面这段代码到上面的位置(有需要的话可以自己手动去修改一下,我这里的代码有一个bug,就是如果没有参数的话会空出一行。不会改,有大佬会改的话在评论区吱我一声,小子不甚感激。)
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == '') return ' '; result+='* @param ' + params[i] + ' '+ ((i < params.size() - 1) ? ' \\n' : ' ')}; return result", methodParameters())
效果
在方法的头上按下/**m+Enter
就可以看到注释了
其他模板代码
以下我是从其他地方复制过来的,没用过,可以自行一试
文件注释标签
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: TODO
* @author A18ccms A18ccms_gmail_com
* @date ${date} ${time}
* @version V1.0
*/
类型(Types)注释标签(类的注释)
/**
* @ClassName: ${type_name}
* @Description: TODO
* @author A18ccms a18ccms_gmail_com
* @date ${date} ${time}
* ${tags}
*/
字段(Fields)注释标签
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
构造函数标签:
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
方法(Constructor & Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 设定文件
* @return ${return_type} 返回类型
* @throws
*/
覆盖方法(Overriding Methods)标签:
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代表方法(Delegate Methods)标签:
/**
* ${tags}
* ${see_to_target}
*/
getter方法标签:
/**
* @return ${bare_field_name}
*/
setter方法标签:
/**
* @param ${param} 要设置的 ${bare_field_name}
*/