IDEA工具第二篇:自定义Java方法注释模板

这篇具有很好参考价值的文章主要介绍了IDEA工具第二篇:自定义Java方法注释模板。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

网上搜索类似的文章有很多,但是一味的复制粘贴总会出现各种奇葩问题,最后然并卵!今天特意自己研究琢磨一下,将最终结果分享给大家,100%亲测可用。

一、说明

想必大家都用过Eclipse的方法注释生成,方法上输入 /**,回车走你,巴拉巴拉如下的注释便生成了,今天就悄悄告诉大家如何自定义这样的模板生成,一般人我可不告诉他😂,快捷的注释模板势必会提升一定的工作效率。

/**
 * 查询学生基本信息
 *
 * @param studentId   学生ID
 * @param studentType V学生类型
 * @return 学生展示对象
 * @author admin
 * @date 2023/06/18 6:18
 */
 public StudentVO queryStudentInfo(Long studentId, Integer studentType) {
     // 省略。。。。。。
 }


二、增加注释模板

1、首先

打开IDEA设置Settings...(Windows快捷键:Ctrl + Alt + S,Mac快捷键:command + ,)---> Editor ---> Live Templates ---> 点击右侧加号"+"

2、然后

设置以下六处相应的内容

以上6处需要注意的地方:

Abbreviation:快捷缩略词,可以输入数值、字母、符号,到时配合 /* 使用(依模板内容而定),例如你输入一个,那么到时候输入/回车即可,以下为本人设置内容(👈此处是关键核心设置内容_)_*

*


Description:实时模板的说明文字,提示显示用,以下为本人设置内容

java方法注释快捷操作


Edit variables:编辑变量按钮,默认灰色不可编辑,只有④中输入了带有 $参数$ 的变量时才会解锁,以下为本人设置内容

param:

由于默认的表达式 methodParameters() 生成的多参数在同一行显示,且格式为 [参数名1, 参数名2....] 这种风格,此处进行改造自定义groovy脚本生成参数列表(👈此处是关键核心设置内容

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


return:

由于默认的表达式 methodReturnType()不返回void类型,此处若想设置成无返回值也返回[@return](https://my.oschina.net/u/556800) void可以通过自定义groovy脚本(👈此处是关键核心设置内容

groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void') { stop=true; }; if(!stop) { result += '\\n'; result += ' * @return ' + data; }; return result;", methodReturnType()) 


date:

对日期格式有要求的,可以在Expression列中对date()加参,以下为本人设置内容

date("yyyy/MM/dd HH:mm")


Template text:模板内容,即自定义注释展示内容,以下为本人设置内容(👈此处是关键核心设置内容

*
 * 一句话描述该方法的作用 $param$  $return$
 * @author admin
 * @date $date$
 */


第一行默认无缩进一个*号,从第二行开始默认缩进一个空格,其中$param$$return$前面不加*号(因为在具体的参数方法里面已做处理),和其它非第一行*号保持对齐。此处格式一定要使用这种,因为会配合下面的groovy脚本解析使用。若修改该内容,切记同时修改相应的groovy脚本,否则生成的注释不堪入目😩。

Applicable contexts:应用于哪个位置,由于此次操作为Java,固只在Java前挑勾应用,以下为本人设置内容

勾选Java下的Comment


Options:其他参数,包括格式化、展开方式等,以下为本人设置内容

Expand with选择Enter,勾选Reformat according to style和Shorten FQ names


3、最后

放上一张设置好的成品图,同时测试一下自定义方法注释,在方法前面输入/**,然后按回车Enter即可

IDEA工具第二篇:自定义Java方法注释模板

3.1、多个参数有返回值:

/**
 * 一句话描述该方法的作用 
 * @param name
 * @param type
 * @return java.lang.Object
 * @author admin
 * @date 2023/08/15 16:28
 */
public Object selectInfoTest(String name, Integer type) { 
    return null;
}


3.2、多个参数无返回值:

/**
 * 一句话描述该方法的作用 
 * @param name
 * @param id
 * @author admin
 * @date 2023/08/15 16:28
 */
public void deleteInfoTest(String name, Integer id) { }


3.3、无参数无返回值:

/**
 * 一句话描述该方法的作用   
 * @author admin
 * @date 2023/08/15 16:29
 */
public void initInfoTest() { }


3.4、单一参数无返回值:

/**
 * 一句话描述该方法的作用 
 * @param id
 * @author admin
 * @date 2023/08/15 20:36
 */
 public void initInfoByIdTest(Integer id) { }


三、总结

完美落幕,如果什么地方有不妥之处,请评论区留言或者私信。

作者:京东零售 马宏伟

来源:京东云开发者社区 转载请注明来源文章来源地址https://www.toymoban.com/news/detail-711455.html

到了这里,关于IDEA工具第二篇:自定义Java方法注释模板的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • IDEA类和方法注释模板设置

        IDEA自带的注释模板不是太好用,我本人在网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家。本人亲测可用,自己配置过 1、File--settings--Editor--File and Code Templates--Files 我们选择Class文件、interface、Enum这三个地方 (1)${NAME}:设置类名,与下面

    2024年02月07日
    浏览(64)
  • 【工具】IDEA开发常用配置-编码设置、自动导包、类注释、方法注释、提示自动忽略大小写、自动换行、SQL格式、格式配置等

    1.1 编码设置 New Projects Settings- Settings for New Projects...-Editor-File Encodings 设置本项目和全局项目编码为 UTF-8 ;配置文件 properties 也需要设置为 UTF-8 ,需勾选 Transparent native-to-ascii conversion ,勾选之后配置文件中文能正常识别。 1.2 自动导包设置 New Projects Settings- Settings for New Proj

    2024年02月04日
    浏览(65)
  • IDEA 配置注释模板

    目录 一、配置类模板注释 二、配置方法注释 打开IDEA,打开 settings ( 快捷键:Ctrl + Alt + s) ,选择 Editor ,找到 File and Code Templates ,设置需要配置注释的文件类型,如下图所示: 选择需要配置注释的文件,填入以下内容:  其他文件类似,按需修改 @ClassName 为 @InterfaceName 或者

    2024年02月11日
    浏览(45)
  • Vscode自定义注释模板

    首先安装插件Doxygen Documentation Generator,安装完成之后点击Doxygen插件的设置,按照下面的步骤打开settings.json进行编辑: 在settings.json中追加如下代码: 切回vscode,在函数上方输入/***/,然后再第二个*后面按一下enter键,自定义注释模板即可生效,如下图: 多插一句嘴,我的主

    2024年02月16日
    浏览(39)
  • 深入浅出Java的多线程编程——第二篇

    目录 前情回顾 1. 中断一个线程 1.1 中断的API 1.2 小结 2. 等待一个线程  2.1 等待的API 3. 线程的状态 3.1 贯彻线程的所有状态 3.2 线程状态和状态转移的意义 4. 多线程带来的的风险-线程安全 (重点) 4.1 观察线程不安全 4.2 线程安全的概念 4.3 线程不安全的原因 4.3.1 修改共享数据

    2024年02月07日
    浏览(82)
  • 【从零开始学习JAVA | 第二十二篇】BigInteger

    目录  前言:  BigInterger: BigInteger常见的方法: 总结:         本篇我们将介绍BigInteger这个比较实用一点的API,这个API在我们实际写项目中都是很实用的API,因此大家应该对这个API有更加熟练的掌握。 在Java中,整数类型int和long的取值范围是有限的,超出该范围的整数无法

    2024年02月15日
    浏览(69)
  • Java学习手册——第二篇面向对象程序设计

    第一章我们已经介绍了Java语言的基础知识,也知道他能干什么了, 那我们就从他的设计思想开始入手吧。 接触一个语言之前首先要知道他的大方向,设计思想是什么样的, 这样接触起来就知道基本原理,才能事半功倍。 迪克斯特拉(E.W.dijkstra)在 1965 年 提出结构化编程,

    2024年02月12日
    浏览(63)
  • idea如何设置注释模板,图文超详细讲解

    目录 先打开idea设置 一,idea类注释 1,找到以下设置 2,设置模板 3,apply保存完成 二,idea方法注释 1,创建自定义的组 2,创建模板 3,设置模板 4,选择生成模板的文件 5,绑定选择参数 6,完成ok 类注释模板和接口注释模板 方法注释模板 生成模板 /** +模板名+快捷键, 选择

    2024年02月14日
    浏览(48)
  • IDEA个性化设置注释模板(详细版)

    类注释模板 方法注释模板 效果展示 类注释模板是IDEA创建类时生成的注释 第一步、File - Settings 第二步、Editor - File and Code Templates - Includes - File Header 点apply,再点ok即可 模板参考如下: 按照 /**+Enter 来设置IDEA的方法注释 步骤 第一步、File - Settings 第二步、选择“Editor”-“L

    2024年02月03日
    浏览(57)
  • 【从零开始学习Java重要知识 | 第二篇】深入解读ThreadLocal类

    目录 前言:  ThreadLocal:  ThreadLocal的内部结构:   ThreadLocal的常用方法: 1.set方法: 2.get方法: 3.setInitialValue方法 remove方法(): ThreadLocalMap:​编辑 成员变量: 存储结构:  高频考点: 总结:          当我们编写多线程程序时,经常会遇到一些需要在线程之间共

    2024年01月18日
    浏览(48)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包