Intellij IDEA 配置注释模板

一、类注释

打开 IDEA 的 Settings,点击 Editor-->File and Code Templates,点击右边 File 选项卡下面的 Class,在其中添加图中红框内的内容:

/**
 * @author jitwxs
 * @date ${YEAR}年${MONTH}月${DAY}日 ${TIME}
 */

在我提供的示例模板中,说明了作者和时间,IDEA 支持的所有的模板参数在下方的 Description 中被列出来。

保存后,当你创建一个新的类的时候就会自动添加类注释。如果你想对接口也生效,同时配置上图中的 Interface 项即可。

二、方法注释

不同于目前网络上互相复制粘贴的方法注释教程,本文将实现以下功能:

  • 根据形参数目自动生成 @param 注解

  • 根据方法是否有返回值智能生成 @Return 注解

相较于类模板,为方法添加注释模板就较为复杂,首先在 Settings 中点击 Editor-->Live Templates

点击最右边的 +,首先选择 2. Template Group... 来创建一个模板分组:

在弹出的对话框中填写分组名,我这里叫做 userDefine:

然后选中刚刚创建的模板分组 userDefine,然后点击 +,选择 1. Live Template

 

 此时就会创建了一个空的模板,我们修改该模板的 AbbreviationDescription 和 Template text。需要注意的是,Abbreviation 必须为 *,最后检查下 Expand with 的值是否为 Enter 键。

上图中· Template text 内容如下,请直接复制进去,需要注意首行没有 /,且 \* 是顶格的

 

 注意到右下角的 No applicable contexts yet 了吗,这说明此时这个模板还没有指定应用的语言:

 点击 Define,在弹框中勾选Java,表示将该模板应用于所有的 Java 类型文件。

设置 applicable contexts
设置 applicable contexts

还记得我们配置 Template text 时里面包含了类似于 $date$ 这样的参数,此时 IDEA 还不认识这些参数是啥玩意,下面我们对这些参数进行方法映射,让 IDEA 能够明白这些参数的含义。点击 Edit variables 按钮:

为每一个参数设置相对应的 Expression

 

需要注意的是,date 和 time 的 Expression 使用的是 IDEA 内置的函数,直接使用下拉框选择就可以了,而 param 这个参数 IDEA 默认的实现很差,因此我们需要手动实现,代码如下:

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())

注:你还注意到我并没有勾选了 Skip if defined 属性,它的意思是如果在生成注释时候如果这一项被定义了,那么鼠标光标就会直接跳过它。我并不需要这个功能,因此有被勾选该属性。

点击 OK 保存设置,大功告成!

三、检验成果

3.1 类注释

类注释只有在新建类时才会自动生成,效果如下:

3.2 方法注释

将演示以下几种情况:

  1. 无形参

  2. 单个形参

  3. 多个形参

  4. 无返回值

  5. 有返回值

方法注释
方法注释

四、Q & A 

(1)为什么模板的 Abbreviation 一定要叫 \* ?Expand with 要保证是 Enter 键?

答:因为 IDEA 模板的生成逻辑是 模板名 + 生成键,当生成键是 Enter 时,我们输入 * + Enter 就能够触发模板。

这也同时说明了为什么注释模板首行是一个 * 了,因为当我们先输入 /*,然后输入 * + Enter,触发模板,首行正好拼成了 /**,符合 Javadoc 的规范。

(2)注释模板中为什么有一行空的 \*

答:因为我习惯在这一行写方法说明,所以就预留了一行空的写,你也可以把它删掉。

(3)注释模板中 $time$$param$ 这两个明明不相干的东西为什么紧贴在一起?

答:首先网上提供的大部分 param 生成函数在无参情况下仍然会生成一行空的 @param,因此我对param 函数的代码进行修改,使得在无参情况下不生成 @param,但是这就要求 $param$ 要和别人处在同一行中,不然没法处理退格。

(4)为什么 return 参数不使用 methodReturnType(), 而要自己实现?

答:methodReturnType() 在无返回值的情况下会返回 void,这并没有什么意义,因此我对 methodReturnType() 返回值进行了处理,仅在有返回值时才生成。

(5)为什么 $return$ 不是单独一行?

答:因为当 methodReturnType() 返回 null 时,无法处理退格问题,原因同第三点。

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
在使用IDEA配置注释模板之前,我们首先需要了解一下注释模板的概念。注释模板是一种预定义的注释格式,通过在代码中插入特定的关键字或标记,可以自动生成一些常用的注释内容,从而提高代码的可读性和维护性。 在IDEA配置注释模板非常简单。首先,打开IDEA设置页面。可以通过点击菜单栏的"File" -> "Settings"(Windows下)或者"Preferences"(Mac下)来打开设置页面。 在设置页面的左侧菜单栏中,选择"Editor" -> "Live Templates"。这里可以看到IDEA内置了一些预定义的模板。 要配置自定义的注释模板,可以在左侧菜单栏中选择对应的语言,比如Java或者Kotlin。然后,在右侧的列表中点击"+"按钮,选择"Template Group"来创建一个新的模板组。 接下来,右键点击刚刚创建的模板组,选择"New Template"来创建一个新的模板。在弹出的对话框中,可以填写模板的名称、缩写、描述等信息。 在模板的内容中,可以使用占位符来引用变量。占位符的格式为`${变量名}$`,比如`${author}$`表示作者的变量。在模板内容中使用占位符来引用变量,可以让生成的注释内容更加灵活和个性化。 配置完模板的内容后,可以点击"Edit Variables"按钮来定义模板中使用的变量。在变量列表中,可以设置变量的名称、默认值和描述等属性。 配置完成后,记得启用"Enable Live Templates"选项,这样在创建新的文件时,才能自动应用你设置的模板注释。 总结一下,配置注释模板的步骤如下: 1. 打开IDEA设置页面。 2. 在左侧菜单栏中选择对应的语言。 3. 创建一个新的模板组。 4. 创建一个新的模板,并设置模板的名称、缩写和内容。 5. 定义模板中使用的变量。 6. 启用"Enable Live Templates"选项。 通过配置注释模板,我们可以在编写代码的过程中,快速生成规范的注释内容,提高代码的可读性和维护性。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [IDEA设置注释模板的方法](https://blog.csdn.net/dianluo4096/article/details/102039848)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] - *2* *3* [idea注释模板设置(史上最全!!!)](https://blog.csdn.net/AwesomeJokerWang/article/details/117784282)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值