java注释模板(idea配置)

找到配置的地方

Settings——>Live Templates
在这里插入图片描述

1、方法注释规范

1.1、写模板文件template text

在这里插入图片描述

**
 * fetch
 * @Author name
 * @Description 
 * @Data $time$ $date$
 $param$
 * @return $return$
 */

1.2、Edit variables

在这里插入图片描述
注:param里面的

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

1.3、使用到java中,选择使用的文件类型

在这里插入图片描述
在这里插入图片描述

1.4、使用该注释

在java中输入
/**
回车即可

2.swagger-ui规范

2.1、写模板文件template text

在这里插入图片描述

@ApiOperation(value = "",notes = " \n author:name")
@ApiImplicitParams({
        $apiparams$
})

2.2、Edit variables

在这里插入图片描述
注:apiparams里面的

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

2.3、使用到java中,选择使用的文件类型

在这里插入图片描述
在这里插入图片描述

1.4、使用该注释

在java中输入
api
回车即可

  • 2
    点赞
  • 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、付费专栏及课程。

余额充值