首页 > 编程语言 >idea java代码注释模板制作 idea类注释模板设置【转载】

idea java代码注释模板制作 idea类注释模板设置【转载】

时间:2023-09-25 21:11:07浏览次数:61  
标签:Author hao idea 快捷键 注释 设置 Date 模板

一、类模板设置
1、进入设置页面:File-->settings-->Editor-->File and Code Templates-->Files
2、设置类、接口、枚举模板信息
3、点击Apply应用设置
二、方法模板设置
1、同样打开设置:File-->settings-->Editor-->Live Templates
2、新建模板组:命名为userDefine
3、选中新建的模板组,新建模板
4、点击Apply应用设置
5、注意:如果想参数分开展示,则需在参数Expession列添加脚本

一、类模板设置

1、进入设置页面:File–>settings–>Editor–>File and Code Templates–>Files

 

2、设置类、接口、枚举模板信息

/** * @ClassName: ${NAME} * @Description: ${description} * @Author: liu-hao * @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} * @Version: 1.0 **/

 

/** * @InterfaceName: ${NAME} * @Description: ${description} * @Author: liu-hao * @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} * @Version: 1.0 **/

 

/** * @EnumName: ${NAME} * @Description: ${description} * @Author: liu-hao * @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} * @Version: 1.0 **/

 

3、点击Apply应用设置

 

 

二、方法模板设置 1、同样打开设置:File–>settings–>Editor–>Live Templates

 

 

2、新建模板组:命名为userDefine

 

 

 

 

 

3、选中新建的模板组,新建模板

新建模板

填写模板信息

模板快捷键:IDEA生成注释的默认方式是:/* + 模板名 + 快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为 /*add+Tab)

快捷键设置(更新):这里建议快捷键使用Tab,以区分系统自带的回车创建注释(下面快捷键还是以回车为例)

方法注释模板

* * @Author: liu-hao * @Description: $description$ * @Date: $date$ $time$ * @Param: $params$ * @return: $return$ **/

 

设置模板的应用场景 设置前 设置后 设置应用场景(选择Java即可) 设置参数的获取方式 点击Edit variables 打开设置 在Expession列选择设置即可

5、注意:如果想参数分开展示,则需在参数Expession列添加脚本

 

groovyScript(" if(\"${_1}\".length() == 2) { return ''; } else { def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { if(i==0){ result += params[i] + ' ' } else { result += '\\n' + ' * @Param: ' + params[i] } }; return result; 

}", methodParameters());

 

原文出处:idea java代码注释模板制作 idea类注释模板设置_烂漫树林的技术博客_51CTO博客

 

 

 

 

 

 

一、类模板设置1、进入设置页面:File–>settings–>Editor–>File and Code Templates–>Files

2、设置类、接口、枚举模板信息代码/*** @ClassName: ${NAME}* @Description: ${description}* @Author: liu-hao* @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}* @Version: 1.0**/1.2.3.4.5.6.7./*** @InterfaceName: ${NAME}* @Description: ${description}* @Author: liu-hao* @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}* @Version: 1.0**/1.2.3.4.5.6.7./*** @EnumName: ${NAME}* @Description: ${description}* @Author: liu-hao* @Date: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}* @Version: 1.0**/1.2.3.4.5.6.7.如图所示(类、接口、枚举)
3、点击Apply应用设置效果展示package com.tygy.maven.test;
/** * @ClassName: User * @Description: 用户类 * @Author: liu-hao * @Date: 2019-10-10 21:39 * @Version: 1.0 **/public class User {// TODO}1.2.3.4.5.6.7.8.9.10.11.12.package com.ychs.maven.test;
/** * @InterfaceName: Persion * @Description: Persion接口 * @Author: liu-hao * @Date: 2019-10-10 21:42 * @Version: 1.0 **/public interface Persion {// TODO}1.2.3.4.5.6.7.8.9.10.11.12.package com.ychs.maven.test;
/** * @EnumName: Persion * @Description: DateEnu枚举 * @Author: liu-hao * @Date: 2019-10-10 21:45 * @Version: 1.0 **/public interface DateEnum {// TODO}1.2.3.4.5.6.7.8.9.10.11.12.二、方法模板设置1、同样打开设置:File–>settings–>Editor–>Live Templates

2、新建模板组:命名为userDefine









3、选中新建的模板组,新建模板新建模板填写模板信息模板快捷键:IDEA生成注释的默认方式是:/* + 模板名 + 快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为 /*add+Tab)快捷键设置(更新):这里建议快捷键使用Tab,以区分系统自带的回车创建注释(下面快捷键还是以回车为例)方法注释模板*  * @Author: liu-hao  * @Description: $description$  * @Date: $date$ $time$  * @Param: $params$  * @return: $return$  **/1.2.3.4.5.6.7.设置模板的应用场景设置前设置后设置应用场景(选择Java即可)设置参数的获取方式点击Edit variables 打开设置在Expession列选择设置即可4、点击Apply应用设置效果展示/**  * @Author: liu-hao * @Description: 通过用户ID获取用户姓名  * @Date: 2019/10/10 21:45  * @Param: [userId]  * @return: java.lang.String  **/public String getName(String userId) {    // TODO    return null;}1.2.3.4.5.6.7.8.9.10.11.5、注意:如果想参数分开展示,则需在参数Expession列添加脚本参数添加脚本groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();for(i = 0; i < params.size(); i++) {if(i==0){result += params[i] + ' '} else {result += '\\n' + ' * @Param: ' + params[i]}};return result;}", methodParameters());1.2.3.4.5.6.7.8.9.10.11.12.13.14.15.效果展示复制 /** * @Author: liu-hao * @Description: 设置用户信息 * @Date: 2019/10/10 21:45 * @Param: userId 用户ID * @Param: userName 用户姓名 * @return: java.lang.String **/public String setUserInfo(String userId, String userName) {    // TODO    return null;}-----------------------------------idea java代码注释模板制作 idea类注释模板设置https://blog.51cto.com/u_14230/6705558

标签:Author,hao,idea,快捷键,注释,设置,Date,模板
From: https://www.cnblogs.com/lychee-wang/p/17728854.html

相关文章

  • P3812 【模板】线性基
    题意给定\(n\)个整数,求这\(n\)个整数的异或最大值。Sol线性基模板题。考虑维护一个线性基。插入一个数时,从高位往低位枚举。遇到第一个基中不存在的位,就将该数加入基,否则异或下去。询问最大值,考虑贪心,若当前\(ans^p[i]>ans\)则直接\(ans^=p[i]\)。#include<i......
  • idea设置项目启动的JVM运行内存大小
    idea设置项目启动的JVM运行内存大小场景在开发当中,idea默认服务启动要占用1G内存。其实每个项目本地开发和调试的时候,根本不需要1G内存,200M左右足以如果在微服务体系下,那效果更明显,相同的内存可以启动更多的服务刚好本人的电脑只有8G,公司的微服务项目启动后,电脑风扇疯狂的转动。解......
  • 【遥遥领先】Eolink IDEA 插件:零代码入侵,自动生成接口
    省流版:Eolink有IDEA插件吗?有,而且遥遥领先!我们在一年半之前就发布了,而且功能更丰富!IDEA插件市场搜索“EolinkApikit”即可安装使用。......
  • com.intellij.diagnostic.PluginException报错导致无法启动idea
    IDEA报错:2023-09-2516:16:56,738[178934]ERROR-nSystem.impl.ActionManagerImpl-[Plugin:com.zhaow.restful.toolkit]com.intellij.diagnostic.PluginException:[Plugin:com.zhaow.restful.toolkit]atcom.intellij.openapi.actionSystem.impl.ActionMa......
  • java项目开发常用配置文件模板
    mybatisconfig文件1<?xmlversion="1.0"encoding="UTF-8"?>2<!DOCTYPEconfiguration3PUBLIC"-//mybatis.org//DTDConfig3.0//EN"4"http://mybatis.org/dtd/mybatis-3-config.dtd">5......
  • 在idea中使用allure
    首先配置maven和allure环境--略环境可能遇到问题见:点击查看在pom.xml文件中引入扫描build标签:<build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-mav......
  • 在idea的控制台使用命令报错XXX无法识别为命令或改变了环境变量后idea环境未同步更新
    报错XXX无法识别为命令是当前环境中不存在XXX配置,当前环境不是说电脑的系统环境,比如使用的idea那当前环境就是idea的配置环境:打开设置(ctrl+alt+s) 在Value中添加XXX对应的路径,记得加分号(;)。 ......
  • 使用Intellij Idea打包java为可执行jar包
    自己在实际工作中的需要,使用Idea打包项目为可执行的jar包,网上找了好多文章但总是不成功,多次尝试后终于跑通,所以记录下来,希望可以帮助各位步骤:1.选中Java项目工程名称,在菜单中选择 File->projectstructure... (快捷键Ctrl+Alt+Shift+S)。2.在弹出的窗口中左侧选中"Artifact......
  • IntelliJ Idea编译报错:请使用 -source 7 或更高版本以启用 diamond 运算符
    最近在使用IntelliJIdea遇到了挫折,分享出来给大家,问题由来是我导入了外部的java文件,结果就报错了错误的句子也提示出来了:KafkaConsumer<String,String>kafkaConsumer=newKafkaConsumer<>(props);网上搜了各种解决方法都不行,崩溃的节奏啊,终于皇天不负有心人,让我同事解决了,希......
  • chart模板实战
    参考:https://helm.sh/zh/docs/chart_template_guide/getting_started/https://helm.sh/zh/docs/chart_template_guide/function_list/一.入门chart1.创建一个charthelmcreatemychart查看目录结构[root@k8s-masterhelm-test]#treemychart/mychart/├──charts├......