【转】IDEA类和方法注释模板设置(非常详细)

article/2025/9/25 4:08:17

  IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。

这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置:

类注释模板:      

       

方法注释模板:

    

一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)

1、File-->settings-->Editor-->File and Code Templates-->Files

我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)

(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名

(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述

(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}

(4)1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了

2、效果图展示

 

二、设置方法注释模板

IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是

/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释

1、File-->Settings-->Editor-->Live Templates

(1)新建组:命名为userDefine

(2)新建模板:命名为*

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

/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、

获取方法返回值的methodReturnType()

(3)设置生成注释的快捷键

(4)设置模板:模板内容如下

注意第一行,只有一个*而不是/*

在设置参数名时必须用${参数名}$的方式,否则第五步中读取不到你设置的参数名

** @Author $NAME$* @Description //TODO $end$* @Date $time$ $date$* @Param $param$* @return $return$**/


如果使用/*生成的模板注释将会是如下效果:所以我们要去掉最前面的/*

(5)设置模板的应用场景

点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere-->Java即可

(如果曾经修改过,则显示为change而不是define)\

(6)设置参数的获取方式

选择右侧的Edit variables按钮

PS:第五步和第六步顺序不可颠倒,否则第六步将获取不到方法

选择每个参数对应的获取方法(在下拉选择框中选择即可),网上有很多教程说获取param时使用脚本的方式,我试过使用脚本

的方式不仅麻烦而且只能在方法内部使用注释时才能获取到参数

(7)效果图

创建方法,在方法上面写:/*+模板名+Enter-->/**+Enter

 
————————————————
版权声明:本文为CSDN博主「吃货刘小念」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/xiaoliulang0324/article/details/79030752


http://chatgpt.dhexx.cn/article/5Qa5Ebne.shtml

相关文章

idea配置Idea类注释模板和方法注释模板(亲测有效)

网上找了很多都不理想,要不就是params为null,取不到值,要不就是格式模板不理想,今天自己整理去做了一下,记录今天操作 1.选择File–>Settings–>Editor–>File and Code Templates进入到下图位置分别设置Cla…

IDEA类和方法注释模板设置(非常详细)

一、概述 IDEA自带的注释模板一般都很简单,然而我们在写代码的时候喜欢把类注释和文档注释写在代码里,既方便自己看所有的参数,也便于以后维护代码的时候看到编码作者。下面是我的代码注释,我们就按照这种格式来设置:…

java字符串反转(java字符串反转义)

java中如何将字符串反转? package string; public class StringTest3 { public static void main(String[] args) String s"abcdefg"; String s2""; char[] css.toCharArray(); for(int ics.length-1;i>0;i--) s2s2cs[i]; System.out.printl…

java字符串反转有哪些方法呢?

java中字符串反转是一个常见的题目,那么今天来总结一下在java中反转字符串的方法到底有哪些: 1、使用java库函数中的方法reverse() private static String reverse1(String s) {StringBuilder stnew StringBuilder(s);return st.…

JAVA字符串反转的三种方法

在键盘中输入asd,反转后得到的是:dsa,这就是字符串的反转;这其中的思路就是运用到逆向遍历的想法。先从键盘中录入字符串,然后获取字符串中的每个字符,再进行逆向的遍历,将遍历的字符放在一个新…

实现java字符串反转的三种方法

实现java字符串反转的三种方法 1.问题描述:将字符串String“abcdefg”实现反转变成 “gfedcba”;用java语言实现。 2.解决方法: ①方法一:利用StringBuffer或StringBuilder的reverse方法。 ②方法二:利用String的toC…

Java将字符串反转的7种方法

java将字符串反转几种方法总结 主要方法: (1)返回字符串的长度。 package com.cn; public class Test {public static void main(String[] args) {String str"hello world";System.out.println("字符串str的长度为&#xf…

Java将字符串反转的几种方式

工作中偶尔会遇到需要将字符串反转的需求,下面来介绍反转字符串的几种方式 一、使用 StringBuilder 或 StringBuffer 的 reverse 方法 他们的本质都是调用了它们的父类 AbstractStringBuilder 的 reverse 方法实现的(需要JDK1.8) /*** 使用S…

Windows8.1环境如何删除FlashHelperService.exe文件

Windows8.1环境如何删除FlashHelperService.exe文件 自从装了最新版Flash,每次开机都会弹出FF广告,看了下进程管理器,显示是FlashHelperService.exe文件,定位文件位置。在C盘:C:\Windows\SysWOW64\Macromed\Flash中找…

Memcached简介

Memcached简介 1.Memcached是什么? Memcached是一套高性能的、分布式存储对象缓存系统。 许多 Web 应用将数据保存到关系型数据库( RDBMS,如 MySQL )中,服务器从中读取数据并显示在浏览器中。 随着数据量的增大、访问的集中,就…

micro和macro Fscore的区别

参考链接 macro是先计算出每一类的类别,然后再求平均 micro是将所有类别混合在一起,计算多类别的共同的F1

MEC架构

文章目录 MEC架构MEC参考架构MEC host:MEC platformMEC applicationMEC 系统级管理Multi-access edge orchestratorOperations Support System (OSS)User application lifecycle management proxy MEC主机级管理MEC platform managerVirtualisation infrastructure …

MCMC

背景 给定一个的概率分布 p(x) , 我们希望产生服从该分布的样本。前面介绍过一些随机采样算法(如拒绝采样、重要性采样)可以产生服从特定分布的样本,但是这些采样算法存在一些缺陷(如难以选取合适的建议分布,只适合一…

Mac’s Homebrew

黄金三问:what,why,how macOS(或 Linux)缺失的软件包的管理器 — Homebrew 官网的说明文档会详细告诉我们。 一:查看Homebrew是否安装下载: 终端输入命令行brew (1)当…

MEC

MEC(Multi-access/Mobile Edge Computing,多接入移动边缘计算)是ETSI(European Telecommunications Standards Institute,欧洲电信标准化协会)提出的边缘计算用于移动通信网络的概念。在边缘计算&#xff0…

Metabolomics

样本选择 血浆 Blood Plasma 血浆主要作用运载血细胞,运输维持人体生命活动所需物质和体内废物等。血浆相当于结缔组织的细胞间质。血浆是血液重要组成部分,呈淡黄色液体(因含有胆红素)。血浆的化学成分水分占90~92%,其…

MACE

作者:无用 QQ:929994365 MACE 目录 介绍 环境搭建 实例运行 一、简介(Introduction) MACE(移动AI计算引擎)是一种针对移动异构计算平台优化的深度学习推理框架。MACE覆盖了常见的移动端计算设备&#x…

操作系统:Win10如何彻底卸载自带的Flash软件

Win10操作系统中,Flash功能是系统自带的,我们无法直接通过应用管理来找到Flash,所以也不能从系统设置或者控制面板中卸载它。当然如果你是后期自己安装的话,可以通过控制面板找到Flash然后直接卸载它。 Flash的路径为“C:\Windows…

Hadoop应用案例分析

hadoop是什么?hadoop能有哪些应用?hadoop和大数据是什么关系?下面我们将围绕这几个问题详细阐述。 hadoop是什么? Hadoop是一个由Apache基金会所开发的分布式系统基础架构。 用户可以在不了解分布式底层细节的情况下,开发分布式程序。充分利用集群的威力进行…

Hadoop 大数据技术原理与应用

Hadoop 大数据技术原理与应用 大数据概述 定义 特征 大量,多样,高速,价值 研究意义 应用场景 医疗,金融,零售 Hadoop 概述 历史 优势 扩容能力强,成本低,高效率,可靠性&a…