IDEA设置新建类注释、手动注释详解

本文详细描述了在IntelliJIDEA中如何设置默认注释模板,包括新建类注释的自动填充和手动注释的自定义设置,以提高代码编写效率。
摘要由CSDN通过智能技术生成

一、背景

每次在一台新电脑安装idea,都需要重新设置idea注释配置,说常用吧,也就新安装时才用,时间久步骤容易忘记,所以用此文章记录一下。

二、模板

此文章我们就用以下模板来进行讲解

/**
 * @author henry
 * @describe  todo
 * @data $date$ $time$
 * @version 1.0
 */


三、设置方法

1、新建类注释设置

此步骤讲解的是新建类的时候,类自动能带出配置好的模板注释

步骤:
1、settings =》 Editor =》File and Code Templates
2、点击includes后在File Header后面的栏框中输入模板内容即可
请添加图片描述

新建类进行测试
在这里插入图片描述

2、手动注释设置

此步骤讲解的是在方法上输入“/*”然后回车,即可自动展示注释模板

步骤:
1、settings =》 Editor =》Live Templates
2、在此目录下新建一个组模版(例如:myGroup)
在这里插入图片描述
3、进行如下设置(在上述myGroup下面新建一个Live Template)
在这里插入图片描述
含义:
1和6结合表示输入/*然后回车就可以自动补全注释模板;2表示对模板做解释;3表示模板;4对模板中的占位符变量进行赋值;5表示模板使用哪些文件,比如java(必须要设置)

ps:对变量的设置
在这里插入图片描述

对设置好的配置进行测试(输入/*,后回车)
在这里插入图片描述

  • 9
    点赞
  • 12
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
IDEA设置注释模板的方法可以通过以下步骤进行: 1. 打开IDEA,点击"File"菜单,然后选择"Settings"。 2. 在"Settings"对话框中,展开"Editor"菜单,然后选择"File and Code Templates"。 3. 在"File and Code Templates"窗口中,选择"File Header"选项卡。 4. 在文本编辑框中,你可以编辑自己的注释模板。 你可以使用${PARAMETER_NAME}$的格式来添加参数。一些常用的参数包括: - ${USER}:当前用户的用户名。 - ${DATE}:当前日期。 - ${TIME}:当前时间。 - ${YEAR}:当前年份。 - ${PACKAGE_NAME}:当前文件的包名。 - ${CLASS_NAME}:当前的名称。 - ${FILE_NAME}:当前文件的名称。 - ${PROJECT_NAME}:当前项目的名称。 - ${COPYRIGHT_HOLDER}:版权所有者。 下面是一个示例的注释模板: ``` /** * Description: * Author: ${USER} * Date: ${DATE} ${TIME} * Version: 1.0 */ ``` 你可以根据自己的需要进行修改和调整。设置完成后,点击"Apply"按钮保存更改。 注意:请确保在模板中使用合适的参数,以便为每个生成适当的注释。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* [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_2"}}] [.reference_item style="max-width: 50%"] - *3* [IDEA和方法注释模板设置(非常详细)](https://download.csdn.net/download/weixin_38690407/12756504)[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 ]

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值