IntelliJ IDEA类和方法注释模板配置
1、设置文件注释
设置Java类的注释模板，创建Java类自动生成该注释模板。
先看文件注释效果：
1.1、选择 IntelliJ IDEA —> 选择 Preferences...
打开IDEA属性设置面板
1.2、选择 File Code Templates—>选择 Includes 选项卡—>选择 File Header，添加注释模板，点击 Apply 和 OK 按钮生效模板配置。
类文件注释模板：
/**** @description: ** @author: ${USER}* @time: ${DATE} ${TIME}**/2、设置方法注释模板
需要实现的方法注释效果，在方法顶上输入/** + Enter即可以给方法添加我们自定义的方法注释。
2.1、打开IDEA属性设置面板
选择 IntelliJ IDEA —> 选择 Preferences...
2.2、添加 Template Group
2.2.1、选择 Live Tempates—> 选择 Template Group...，打开添加模板组面板。
2.2.2、填写模板组名称 MyCodeGroup,名称可以自己自定义。
2.2.3、选择 Live Template,选中我们刚刚创建的MyCodeGroup，选择Live Template，给我们刚刚创建的模板组添加自定义动态模板。
2.2.4、填写模板信息
选中我们刚刚添加的Live Tempate，填写相关信息。
添加快捷键与注释
Abbreviation关键字
Description模板说明
模板信息内容：
** description: $description$ <br>* date: $date$ $time$ <br>* author: $user$ <br>*
$params$* @return $return$*/注意上述文字一定要一个字不差的填写, 我的模板并没有写歪, 而是必须要这么写才能正常使用, 关键字需要用
*, 不要改动。
2.2.5、给模板注释添加动态函数值
选择 Edit variables , 填写相关信息，填写完，点OK完成。
依次对应的函数值：
methodName()
date()
time()
user()
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++) {result +=((i==0) ? '\\r\\n' : '') + ((i < params.size() - 1) ? ' * @param: ' + params[i] + '\\r\\n' : ' * @param: ' + params[i] + '')}; }; return result;", methodParameters())
methodReturnType()$date$ $time$ $params$ $return$ 这些用$符号包括的代码 这些都是自定义变量, 而我想在写注释的时候实时获取这些, 比如时间, 日期, 参数名, 返回值类型 所以需要关联编译器的变量自动填入。
2.2.6、设置模板应用的语言为 java
2.2.7、设置展开的快捷键，默认是 Tab 键
习惯可以设置为回车键 Enter。
至此设置完成，在方法名输入 /** + Enter即可以显示出相关注释。
3、设置类注释模板
IDEA 是没有像Eclipse方便的类注释，需要自己添加。比如在类文件 头部输入
cls+Enter快捷键对应开头的文件注释。
3.1、选择 Live Template,选中我们刚刚创建的MyCodeGroup，选择Live Template，给我们刚刚创建的模板组添加自定义动态模板。
3.2、填写模板信息
选中我们刚刚添加的Live Tempate，填写相关信息。
添加快捷键与注释
Abbreviation关键字
Description模板说明
模板信息内容：
/**
* @description: $CLASS_NAME$
* @author: $USER$
* @time: $DATE$ $TIME$
*/注意上述文字一定要一个字不差的填写, 不要改动。
3.3、给模板注释添加动态函数值
选择 Edit variables , 填写相关信息，填写完，点OK完成。
依次对应的函数值：
className()
user()
date()
time()CLASS_NAME USER $DATE$ $TIME$ 这些用$符号包括的代码 这些都是自定义变量, 而我想在写注释的时候实时获取这些, 比如时间, 日期,所以需要关联编译器的变量自动填入。
3.4、设置模板应用的语言为 java
3.5、设置展开的快捷键，默认是 Tab 键
习惯可以设置为回车键 Enter。
至此设置完成，在方法名输入 cls + Enter即可以显示出相关注释。
IntelliJ IDEA类和方法注释模板配置相关推荐
- IntelliJ IDEA 2022 类和方法注释模板设置
一.概述 IDEA自带的注释模板一般都很简单,然而我们在写代码的时候喜欢把类注释和文档注释写在代码里,既方便自己看所有的参数,也便于以后维护代码的时候看到编码作者.下面是我的代码注释,我们就按照这种格 ...
- IDEA类和方法注释模板设置（非常详细、实用）
点个赞,看一看,好习惯!本文 GitHub https://github.com/OUYANGSIHAI/JavaInterview 已收录,这是我花了 3 个月总结的一线大厂 Java 面试总结,本 ...
- IDEA类和方法注释模板设置
这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置: 类注释模板: /**** @ClassName: TestType* @Descriptio ...
- idea设置Java类和方法注释模板
1.创建类/接口时,自动生成注释模板 按照步骤(mac版本):IntelliJ IDEA->Preferences->Editor->File and Code Templates- ...
- Idea 设置类、方法注释模板(解决params和return显示问题)---不来虚的 实测有效
目录 1.使用场景 2.操作步骤 2.1.新建类模板注释添加 2.2.给类的方法生成方法注释 3.成果展现 4.参考文章 1.使用场景 我们在开发项目的时候需要知道类的创建者,什么时间创建,这个类是什 ...
- IDEA设置类、方法注释模板
类注释模板 File -> Other Setting -> Default Setting打开默认设置 Editor -> File and Code Templates -> ...
- IDEA类和方法注释模板
先看效果 类 创建类的时候先描述这个类干啥用的 方法 先说创建类的注释模板 选择class 类注释模板 /** * * @description ${description}* @date ${DAT ...
- IDEA 方法注释模板配置
params参数脚本: groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\ ...
- IDEA设置类注释模板和方法注释模板
1.设置类注释模板 File -> Settings -> Editor -> File and Code Templates -> Files 选择Class.Interfa ...
最新文章
- 通过BeanShell获取UUID并将参数传递给Jmeter
- 模拟一个连接来自搜索引擎
- 用Python找出数组中出现次数超过一半的数
- MOSS Content Types 概述
- 【Swift学习笔记-《PRODUCT》读书记录-实现自定义转场动画】
- php中等腰金字塔挖空,php 用for循環做，金字塔，菱形，空三角
- 性能是.NET Core的一个关键特性
- 避免Gson使用时将一些字符自动转换为Unicode转义字符
- 运营商缺的是应用还是想法--广州晨皓
- matplotlib 等高线的绘制 —— plt.contour 与 plt.contourf
- groupby多个字段性能_SQL 性能优化
- Codeforces Round #422 (Div. 2) D. My pretty girl Noora [数论][dp]
- win10计算机无访问权限,win10系统提示无internet访问权限怎么办
- uva10246最短路 ＋ 枚举 ＋ 数组记忆
- qcon_从QCon伦敦2010中学到的重点知识和教训
- 对于VmWare WorkStation在桥接模式下与虚拟机互ping不通问题解决方案
- 解决ubuntu下wps卡顿和缺少字体
- ai动漫生成软件哪个好？这篇文章告诉你
- 使用线性SVM实现对垃圾邮件分类
- 计算机怎样格式u盘,win10系统电脑怎么操作把u盘格式化为fat32格式？