idea配置注释

一、设置类的注释模板

1、选择File→Settings→Editor→File and Code Templates→Files→Class。可以看到创建Class时引入了一个参数"File Header.java"。对应的是Files旁边的Includes→File Header文件。

 

2、File Header里就是创建类时的注释模板,下面Description中有描述一些可以配置的参数,可以根据自己需要选用。

二、设置方法的注释模板

1、选择File→Settings→Editor→Live Templates。点击右边的加号,选择Template Group,创建一个分组。

 

2、再点击加号,选择Live Template,创建一个模板。其中:

Abbreviation:填模板的缩写,可以使用*号作为代号,方便后面调用模板。

Options→Expand with:填注释模板的扩展快捷键,根据使用习惯,这里使用默认的Tab。

 *
 * @Author: feiyiban
 * @Descriprion: TODO
 * @Date: $time$ $date$ 
 * @Return: $return$
 * @Param: $param$
 */

3、点击模板页面最下方的警告define,来设置将模板应用于哪些场景,选择Everywhere-->Java即可。

4.使用        /** +Enter 生成注释

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 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、付费专栏及课程。

余额充值