idea 中配置注释的自动生成问题
程序员文章站
2022-06-13 16:34:02
...
一、类文件注释
1)配置新生成文件的注释:
在file Header中复制如下内容:
/** @ClassName: ${NAME}
* @Description:
* @Author ${USER}
* @Date ${DATE} ${TIME}
* @Version V1.0
*/
2)给已经存在的类文件添加注释。在live templates中配置 快捷键cmt,可自定义.$desc$变量不要设置skip,其他可以设置skip这样可以让光标默认停留在功能描述
/** @ClassName: $name$
* @Description:$desc$
* @Author $USER$
* @Date $date$ $time$
* @Version V1.0
*/
二.方法注释(在live templates中配置)
1)不要用/**开头,应该用*开头,快捷键用*号(生成时输入/**)。否则methodName()无法取到值。如下内容放入模板框:
*
* @method $methodName$
* @description 功能描述:
* $desc$ $END$
* @date: $date$ $time$
* @author: zhangcs
$param$
* @return $return$
*/
2)param变量的缺省值设置为:
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())
3)$desc$变量不要设置skip,其他可以设置skip这样可以让光标默认停留在功能描述