IDEA自动生成类和方法注释

原创已于 2023-04-24 16:37:12 修改 · 3.1k 阅读

10 ·

CC 4.0 BY-SA版权

文章标签：

#java #开发语言

于 2023-04-24 16:33:50 首次发布

本文介绍了如何在IDEA中设置和使用注释模板，包括类注释和方法注释。类注释涉及作者、创建日期和描述，方法注释提供参数、返回值信息。用户可以通过预设的模板，在创建新类或方法时自动生成规范的注释，提高编码效率。

效果图

一、类注释

1. 创建

2. 向header文件中添加内容

/**
 * @author: 作者
 * @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 * @Description: 
 */

3. class文件关联header配置

4. 使用方法

创建类时候自动生成。

二、方法注释

输入模板内容：

注意格式不要修改了，否则会乱。

*
    * @Description:
    * $VAR1$
$params$ * @return $returns$
        */

VAR1参数内容：

groovyScript("def result='';  def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();  for(i = 0; i < params.size(); i++) {  if(i!=0)result+= '* ';  result+='@param ' + params[i] + ((i < (params.size() - 1)) ? '\\n' + '\\t' : '');  };  return result", methodParameters())

returns参数内容：