首页 > 其他分享 >【idea技巧篇】idea的类注释和方法注释模版自定义设置

【idea技巧篇】idea的类注释和方法注释模版自定义设置

时间:2024-10-15 18:48:07浏览次数:7  
标签:return 当前 自定义 模版 idea 注释 设置 date

这块idea技巧虽然常用,谁没事会经常修改模版设置呢,一般是搭建开发环境的时候或者开发规范要求等设置一次就行了。用的虽然少,但几乎每次搭建环境都会用到,这里记录下并分享设置的过程已经发现的更高级的一些使用技巧。

注释模版

idea默认创建java文件时,是不会生成类注释的,但是一般要求统一格式,需要带上类的注释,下图是一个简单的模版,具体模版可以自定义设置,这里分享下如何设置注释模版。
在这里插入图片描述

如何设置

设置文件头方式

效果就是每次创建java文件,会自动带上注释内容。这种方式设置比较简单,只适用于新建Java文件时生效,而且全局统一,推荐使用这种方式进行全局设置。
配置路径:Settings -> Editor -> File and Code Templates -> File Header
配置内容:

/**
 * 负责实验执行,故障摘除等逻辑
 * @author: wanglianhai
 * @date: 2024/8/9 16:52
 */

在这里插入图片描述
效果如下:
在这里插入图片描述

可用的变量如下:

预定义变量取以下值:
${PACKAGE_NAME}新文件创建时所属的包名
${USER}当前用户的系统登录名
${DATE}当前系统日期
${TIME}当前系统时间
${YEAR}当前年份
${MONTH}当前月份
${MONTH_NAME_SHORT}当前月份名称的前三个字母。例如:Jan, Feb等
${MONTH_NAME_FULL}当前月份的全名。例如:January, February等
${DAY}当前月中的日期
${DAY_NAME_SHORT}当前星期名称的前三个字母。例如:Mon, Tue等
${DAY_NAME_FULL}当前星期的全名。例如:Monday, Tuesday等
${HOUR}当前小时
${MINUTE} 当前分钟
${PROJECT_NAME} 当前项目名称

通过模版自定义

Live Template这种方式可以自定义很多模版以及快捷的设置,而且可以参考注释模版的设置,然后去拓展定义其他模版。

  1. 配置路径:settings -> Editor -> Live Templates,如下图:
    在这里插入图片描述
  2. 创建Template
    在这里插入图片描述
    模版:
/**
* Description: <br/>
* @date: $DATE$ $TIME$<br/>
* @author: your name <br/>
* @since JDK 1.8
*/
  1. 看到其中有DATE和TIME变量,还需编辑变量,同理参考这种方式,可以设置用户名等其他变量,内置了很多变量,下拉可以查看。
    在这里插入图片描述
  2. 效果:
    在这里插入图片描述
    回车生成注释内容
    在这里插入图片描述

进阶使用

设置变量函数,上一篇已经看到有内置的函数了,同时我们也可以自定义自己的函数如下图:
在这里插入图片描述

我们尝试设置JavaDoc格式的方法注释模版:
在这里插入图片描述
模版内容,注意下面内容是只有一个*,这样快捷键可以设置成*, 不然会取不到方法参数。

*
 * @description
 * @author xiaohei 
 * @date $date$ $time$
 * @param $param$
 * @return $return$
 **/

获取参数param的脚本:

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

获取返回值脚本:

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())

其他Live Template

参考如下,可以设置各种编程语言的快捷键已经自动生成的内容,参考如下图:
在这里插入图片描述

常见的模版内容参考

类注释模版

最简单的类注释模版, 我一般使用这种,比较简介明了,生成完添加下类的功能说明就好了,需要其他信息可以

/**
 * 
 * @author: xiaohie
 * @date: ${DATE} ${TIME}
 */

复杂一点的

/**
 * @className: XXDemo
 * @description: 演示使用
 * @author: xiaohei
 * @date: $date$ $time$
 **/

方法注释模版

我一般就用默认的就够了,如果需要调整可以参考以下几种模版:

*
 $param$
 * @description: TODO
 * @return: $return$
 * @author: xiaohei
 * @date: $date$ $time$
 */

标签:return,当前,自定义,模版,idea,注释,设置,date
From: https://blog.csdn.net/Kingsea442/article/details/142940755

相关文章

  • 【Shiro】8.后端服务接口注释
    通过给接口服务方法添加注解可以实现权限校检,可以加在控制器方法上,也可以加在业务方法上,一般加在控制器方法上。@RequiresAuthentication验证用户登录,等同于方法subject.isAuthenticated()@RequiresUser验证用户是否被记忆;登录认证成功subject.isAuthenticated()为true......
  • Java 列表元素自定义排序
    在Java开发过程中,有时会遇到需要对列表中元素进行自定义的排序。这样的排序往往不能由元素本身的特性(比如字符串长度、首字母顺序)判断,需要自己指定顺序。比如对汉字的数字进行排序,他们的字符串长度都为1,首字母顺序也不能得到预期的结果,因此需要自定义排序。以下是示例代码:p......
  • Delphi 自定义窗体(最大化、最小化、关闭、窗体的移动)
    UsesShellAPI;1、//最小化procedureTForm1.btn1Click(Sender:TObject);varI,J,X,Y:Word;begin//第一种:最小化在屏幕的左下角,不是常见的最小化//WindowState:=wsMinimized;//第儿种:最小化在任务栏里面,是常见的最小化postmessage(Self.Handle,WM_SYSCOMMAN......
  • 自定义线程池的使用
    现在有一个使用多线程进行调优的案例:模拟使用多线程并发处理数据。1.自定义一个线程池//自定义一个线程池classThreadPoolManger{privatefinalThreadPoolExecutorexecutor;privatefinalAtomicBooleanisShutdown;/***构造方法,用于初始化线程......
  • IntelliJ IDEA 快捷键大全(也适用全家桶其他编辑器)
    以下是IntelliJIDEA的常用功能快捷键大全,适用于Windows/Linux系统(Mac用户可将Ctrl替换为Cmd,Alt替换为Option):功能分类功能描述快捷键(Windows/Linux)基本操作显示所有快捷键Ctrl+J显示主菜单Alt+Home全局搜索(任何内容)DoubleShift打开设置Ctrl+Alt+S保存所......
  • Ribbon-Loadbalancer自定义负载均衡策略:本地优先+偏向服务器优先
    Ribbon核心顶层抽象packagecom.netflix.loadbalancer;publicinterfaceIRule{Serverchoose(Objectvar1);voidsetLoadBalancer(ILoadBalancervar1);ILoadBalancergetLoadBalancer();}继承IRule实现choose方法默认实现我们这里说明现有的集......
  • IDEA配置maven主目录(maven home)不生效
    原文链接:IDEA配置maven主目录(mavenhome)不生效–每天进步一点点(longkui.site)0.背景使用IDEA搭建SpringBoot项目,搭建完成后开始报错,报错信息如下:java.lang.RuntimeException:java.lang.RuntimeException:org.codehaus.plexus.component.repository.exception.Component......
  • VsCode 如何自定义代码片段(Code Snippet)
    前言在现代前端开发中,提高工作效率是每个开发者的追求。VisualStudioCode(Vscode)作为一款强大的代码编辑器,提供了许多让开发者高效编程的功能,其中自定义代码片段(CodeSnippet)便是一个重要的工具。通过自定义代码片段,你可以快速插入常用的代码模板,大幅减少重复工作量。本......
  • HTML DOM 教程---操作自定义属性(2)
    <!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><metahttp-equiv="X-UA-Compatible"content="IE=edge"><metaname="viewport"content="width=d......
  • IDEA如何用maven打包(界面和命令两种方式)
    前言我们在使用IDEA开发时,如果是springboot项目的话,一般是用maven来管理我们的依赖的。然后,当我们开发完成之后,就需要打包部署了。 那么,我们应该如何打包呢?如何打包(jar包)首先,我们点击右侧的maven侧边栏,然后点击里面的【clean】,先将以前的包清理掉。然后,我们等待clean完成......