超详细设置Idea类注释模板和方法注释模板

网上找了一下,没有很详细且正确介绍Idea配置注释模板的,于是结合多篇文章自己琢磨整理出如下。

设置类注释模板

1.选择File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header.
这里写图片描述

2.在右边空白处,编写自己的模板即可,注意Scheme是模板的生效范围,可选变量在description有介绍,附图中本人使用的模板(${USER}为计算机用户名,可以自行修改)。

/**
 * @Auther: ${USER}
 * @Date: ${DATE} ${HOUR}:${MINUTE}
 * @Description: 
 */

3.设置完成后,创建类时自动生成注释,效果如下。
这里写图片描述

设置方法注释模板

Idea没有可以直接设置方法注释模板的地方,可以借用Live Templates基本实现,步骤如下。
1.选择File–>Settings–>Editor–>Live Templates,先选择右侧绿色加号新建一个自己的模板组,如图命名为myGroup。
这里写图片描述

2.选中已建好的组,选择右侧绿色加号新建模板,如下图。
这里写图片描述

3.填好Abbreviation(快捷输入),Description(描述)和模板内容(图中模板如下)

/**
 *
 * 功能描述: 
 *
 * @param: $param$
 * @return: $return$
 * @auther: $user$
 * @date: $date$ $time$
 */

4.点击Define,勾选Java
这里写图片描述

5.点击Edit variables编辑变量,设置如下,点击Ok–>Apply完成设置。
这里写图片描述

6.输入“/**”,然后按Tab键即可生成注释,如下图。注意此方式有个缺点,需要在方法内部生成,否则@param为null。
这里写图片描述

  • 46
    点赞
  • 155
    收藏
    觉得还不错? 一键收藏
  • 18
    评论
在IntelliJ IDEA设置方法注释模板可以按照以下步骤进行操作: 1. 首先,点击菜单栏中的 "File",然后选择 "Settings"。 2. 在弹出的窗口中,选择 "Editor" -> "Live Templates"。 3. 在右侧的面板中,点击 "+" 图标,然后选择 "Template Group..." 来添加一个新的组。 4. 给这个新的组命名。 5. 再次点击 "+" 图标,选择 "Live Template" 来添加一个新的模板。 6. 配置注释模板,可以设置一个缩写,比如 "/**",然后在方法的上方输入 "/**",按下补全键(默认是 Tab 键)就可以按照你设置模板生成注释了。 7. 对新建模板进行描述,设置注释模板的内容。 8. 可以选择设置补全键,默认是 Tab 键,你也可以设置为 Enter 键。 9. 设置注释模板后,记得启用 "Enable Live Templates",这样在创建新的文件时才会自动生成你设置模板注释。 这样,你就可以方便地设置和使用idea方法注释模板了。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *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_2"}}] [.reference_item style="max-width: 50%"] - *2* [IDEA设置方法注释模板](https://blog.csdn.net/engerla/article/details/119254597)[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_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]
评论 18
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值