类和方法注释模板设置

一、类模板设置:
1、File–>settings–>Editor–>File and Code Templates–>Files,选择class文件。
(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名
(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述
(3) ${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间
(4)1.0:设置版本号
在这里插入图片描述
2、效果图:
在这里插入图片描述
二、方法模板设置:
1、File–>Settings–>Editor–>Live Templates
在这里插入图片描述
(1)新建组:命名为userDefine
在这里插入图片描述
(2)新建模板:命名为/*
在这里插入图片描述
(3)设置生成注释的快捷键
在这里插入图片描述
(4)设置模板:模板内容如下

/**
 * @Description: 
 * @Author: $user$
 * @Date: $date$ $time$
 $param$
 * @Return: $return$
 */

(5)设置模板的应用场景:点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可。如果曾经修改过,则显示为change而不是define
在这里插入图片描述
(6)设置参数的获取方式:选择右侧的Edit variables按钮
在这里插入图片描述
选择每个参数对应的获取方法,获取param时使用脚本的方式,在param 对应的Default value列添加以下代码:

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

在这里插入图片描述
(7)效果图:在方法上面写:/*然后按回车键Enter
在这里插入图片描述

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
在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 ]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值