配置idea的注释模板

配置类、接口等文件的文件头注释:

 添加内容如下:


/**
*
* ${description}
* @author zhangxz
* @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*/

添加方法注释:

  步骤1:

    添加内容如下:

*
* TODO
* @author zhangxz
* @date $date$ $time$
$param$
* @return $return$
* @throws
*/

     注意:上面内容是以“*”开头的,而不是斜杆。并且注释的缩写(abbreviation),是“*”,这是因为idea的注释是以这种格式来命名的:/* + abbr + Tab/Enter。

  步骤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) ? '\r\n' : '')}; return result", methodParameters()) 

  步骤3: 配置注释的应用范围

  

至此,方法注释配置完成,直接通过 /** + Enter/Tab 快捷键使用即可。

参考的博客:

  https://blog.csdn.net/xiaoliulang0324/article/details/79030752

  https://www.cnblogs.com/pcheng/p/10121683.html

原文地址:https://www.cnblogs.com/zhangxuezhi/p/11847649.html