java idea 配置注释模板

article/2025/9/25 2:34:06

java idea 配置注释模板

最近项目组在加强代码规范管理。代码优雅从代码注释开始。奥力给!!!

类注释的

File >> Settings >> Editor >> File and code Templates >> Files >> class
在这里插入图片描述
上图中的模板内容如下:

 /*** @description:* @PackageName: ${PACKAGE_NAME}* @ClassName: ${NAME}* @copyright: Copyright (c) 2022<br>* @company: xxx* @author: xxx* @date: ${DATE} ${TIME}* @version: 1.0*/public class ${NAME} {}

方法或者属性模板的配置

File >> Settings >> Editor >> Live Templates
在这里插入图片描述
方法或者属性的注释模板;
1)先创建分组
2)然后在分组下面创建对应的 注释模板
在这里插入图片描述
上图两处是决定输入什么弹出。
在这里插入图片描述
template text 如下图

** @description$params$* @return $return$ * @author czj       * @date $DATE$ $TIME$*/

上图中的 params

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

上图中的 return

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodReturnType()) 
注意上图  params 和   return 位置

引用博客

https://blog.csdn.net/yy12345_6_/article/details/123830038
https://blog.csdn.net/zeal9s/article/details/83514565
https://blog.csdn.net/xiaoliulang0324/article/details/79030752

http://chatgpt.dhexx.cn/article/lJLBsQtg.shtml

相关文章

idea类注释模板,方法注释模板。

idea设置--实时模板 新建组 类模板 /*** description $description$* author YJJ* date $date$ $time$* version 1.0*/ 方法模板 ** * description $description$ $params$ $return$* author YJJ* date $date$ $time$*/ params脚本&#xff1a; groovyScript("def r…

IDEA代码注释模板

存在问题: 每次写代码&#xff0c;新建类都没有注释&#xff0c;这对一个拥有代码强迫症患者来说&#xff0c;是多么不爽的一件事&#xff0c;不利于开发和后期问题排查 举个例子&#xff1a; 上次写代码的时候&#xff0c;这一段只有我和上帝知道&#xff0c;而现在&#xff0…

idea添加注释模板

自动添加描述 class // 创建时间有的也没有 仅仅就是class的描述信息&#xff0c;看个人公司情况吧&#xff0c;描述信息最好创建时间有一个空行&#xff0c;我忘记了/** * 描述信息 * * create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} */method // 一会要写入模板的内…

【idea生成类注释模板快捷键设置】

idea类注释模板快捷键 设置在方法上生成注释的快捷键1&#xff0c;ctrlaltS打开idea设置设置模板中的参数取值来源使用效果展示 设置在方法上生成注释的快捷键 1&#xff0c;ctrlaltS打开idea设置 设置模板中的参数取值来源 使用效果展示

IntelliJ IDEA类和方法注释模板配置

1、设置文件注释 设置Java类的注释模板&#xff0c;创建Java类自动生成该注释模板。 先看文件注释效果&#xff1a; 1.1、选择 IntelliJ IDEA —> 选择 Preferences... 打开IDEA属性设置面板 1.2、选择 File Code Templates—>选择 Includes 选项卡—>选择 File He…

IDEA配置方法类注释模板

IDEA配置方法类注释模板 IDEA20.1配置方法注释注释的种类注释使用规范 摘自阿里开发手册 IDEA方法模板注释一、打开idea 点击菜单File->Setting-Editor->Live Template二、选择Live Template 添加快键键缩写注释模板代码三、配置Edit variables四、配置入参和返回字段的d…

IDEA类和方法注释模板配置

1、类的注释模板配置 File-->Settings-->Editor-->File and Code Templates-->File --->Class: 模板代码下所示&#xff1a; /*** ClassName: ${NAME}* Author : ${USER}* Date :${DATE} ${TIME}* Description: TODO* Version :1.0*/ 上述${NAME}为类名&…

IDEA方法注释模板设置

IDEA类和方法注释模板设置 1、File–>Settings–>Editor–>Live Templates &#xff08;1&#xff09;新建组&#xff1a;命名为userDefine &#xff08;2&#xff09;新建模板&#xff1a;选中你刚才创建的组&#xff0c;然后右上角新建模板&#xff0c;命名为* &…

IDEA注释模板配置

最初&#xff0c;从Eclipse转到IDEA&#xff0c;总是不习惯IDEA的注释方式&#xff0c;所以在网上找来找去加上自己的测试&#xff0c;终于形成一套相对详细的配置流程。之前每次用到都靠收藏里的别人文章应付&#xff0c;但是在配置新的开发环境或者有新的小组成员加入时总要用…

IDEA类文档注释模板设置

IDEA类文档注释模板设置&#xff1a; 在【File and Code Templates】页面设置类&#xff08;Class&#xff09;的文档注释 . 注意&#xff1a;public class ${NAME} {}一定不能删 /***ClassName ${NAME}*Description TODO*Author ${USER}*Date ${DATE} ${TIME}*Version 1.0*…

IDEA 创建类注释模板

一、引言 在写Java代码过程中&#xff0c;当我们创建类的时候往往需要在类上写一些注释信息&#xff0c;而这些注释信息就主要是几个注释点&#xff0c;如果全部都手写就比较浪费时间了&#xff0c;这个时间后我们就可以通过使用注释模板添加自己的自定义的注释在类或者方法上。…

IDEA 设置注释模板顺序

配置注释模板Live Templates时&#xff0c;模板展示顺序只会按照首字母顺序进行排序&#xff0c;若想按照自己配置的模板进行排序&#xff0c;可按照下图关闭设置即可。

IDEA设置注释模板

目录 一、设置类注释模板 二、设置方法注释模板 一、设置类注释模板 打开File->setting->File and Code Templates,选择Includes&#xff0c;选中File Header.如下图所示&#xff1a; 勾选"Enable Live Templates",在内容框中填入注释模板信息。 /*** 创建…

【IDEA类注释模板和方法注释模板】

IDEA类注释模板和方法注释模板 前言一、设置IDEA 中的类注释模板二、定义方法注释模板每天一个小知识 前言 在我们的开发过程中。良好的代码习惯总是重要的&#xff08;ps&#xff1a;编程两大痛苦&#xff1a;别人不写注释文档&#xff0c;自己写注释文档&#xff09;&#x…

idea类注释模板快捷键设置

类 在idea 中java类创建的时候就会带上注释模板&#xff0c;所以不用快捷键也可以的 变量 描述 ${DATE} 当前系统日期 ${DAY} 当月的当天 ${DS} 美元符号。此变量用于转义美元字符&#xff0c;因此不会将其视为模板变量的前缀。 ${END} 完成编辑变量后的插入位置 ${HOUR}…

idea 设置类的注释模板

在Idea工具中&#xff0c;点击File >> Settings >> Editor >> File and Code Templates >> Files&#xff0c;选择class &#xff08;或者直接按快捷键&#xff1a;Ctrl Alt S&#xff09; 在右侧根据需要输入模板内容&#xff1a; /***Author: JYC…

idea 类注释模板

/*** Description: ${Description}** Author yangwj* Date ${YEAR}-${MONTH}-${DAY} ${TIME}* Version 1.0*/

idea注释模板设置(史上最全!!!)

旧账号不用了&#xff0c;重新弄了一个新账号 发个简单的文章&#xff0c;活跃一下账号。 idea的模板设置相信各位也查了不少了&#xff0c;或者也已经形成了自己的常用模板设置。 以下内容可以作为各自的参考&#xff0c;对于新手来说也可以作为一个入门导向&#xff0c;来…

idea如何设置注释模板,图文超详细讲解

目录 先打开idea设置 一&#xff0c;idea类注释 1&#xff0c;找到以下设置 2&#xff0c;设置模板 3&#xff0c;apply保存完成 二&#xff0c;idea方法注释 1&#xff0c;创建自定义的组 2&#xff0c;创建模板 3&#xff0c;设置模板 4&#xff0c;选择生成模板的…

IDEA创建类注释模板和方法注释模板

参考链接&#xff1a; IDEA 创建类注释模板和方法注释模板 - 简书 IDEA自定义模板注释(解决了参数与返回值为空的问题) - 庄小周 - 博客园 IDEA类和方法注释模板设置&#xff08;非常详细&#xff09; - 十月围城小童鞋 - 博客园 IDEA类和方法注释模板设置&#xff08;非常详…