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

article/2025/9/24 11:42:08

一、概述

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

类注释模板:

方法注释模板:

二、类注释模板

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

(1)@BelongsProject:当前项目的名称

(2)@BelongsPackage:当前包的名称

(3)@Author:作者姓名(可以写死,写成你的名字)

(4)@CreateTime:该类创建的时间

(5)@Description:对该类的描述(该类的功能)

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

/**
*@BelongsProject: ${PROJECT_NAME}
*@BelongsPackage: ${PACKAGE_NAME}
*@Author: yanhongwei
*@CreateTime: ${YEAR}-${MONTH}-${DAY}  ${HOUR}:${MINUTE}
*@Description: TODO
*@Version: 1.0
*/

三、方法注释模板

1、创建模板 

IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,我们的习惯是 /**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释

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

 (1)新建组:命名为userDefine

(2)新建模板:选中你刚才创建的组,然后右上角新建模板,命名为* 

        因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为: /*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、获取方法返回值的methodReturnType()

 2、设置模板内容-IDEA格式模板

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

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

注意:下面这段是代码,可以直接复制的!可以直接复制的!可以直接复制的!不要再问我为什么都是图片了,留着眼睛干啥?

** @description:* @author: yanhongwei * @date: $date$ $time$* @param: $param$* @return: $return$**/

4、设置模板应用场景

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

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

5、设置参数

把右侧的Expand with:改为Enter ;然后选择右侧的Edit variables按钮

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

 1、IDEA格式的模板只需要为每个参数选择对应的方法即可

 2、设置成功后点击OK,返回项目新建一个方法,写完入参和返回值以后,在方法上面:

         敲出:/** 回车

5、JavaDoc格式

 该格式和IDEA格式略有不同:(@param      @return

(1)返回上面第二步中的格式设置:输入下面代码(注意格式

** @description:* @author: yanhongwei * @date: $date$ $time$ $param$ $return$**/

(2)参数设置(JavaDoc格式的需要自定义参数以及返回值的实现方式)

获取参数实现方式:

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())

如果返回值不想有报名,可以使用下面这个参数: 

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())

  (3)设置成功后点击OK,返回项目新建一个方法,写完入参和返回值以后,在方法上面:

         敲出:/** 回车

        然后会显示:(注意不一样的地方)

 大家可以根据自己的爱好和风格去设置!!!


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

相关文章

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

java中如何将字符串反转&#xff1f; 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中字符串反转是一个常见的题目&#xff0c;那么今天来总结一下在java中反转字符串的方法到底有哪些&#xff1a; 1、使用java库函数中的方法reverse&#xff08;&#xff09; private static String reverse1(String s) {StringBuilder stnew StringBuilder(s);return st.…

JAVA字符串反转的三种方法

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

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

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

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

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

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

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

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

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

Memcached简介

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

micro和macro Fscore的区别

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

MEC架构

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

MCMC

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

Mac’s Homebrew

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

MEC

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

Metabolomics

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

MACE

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

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

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

Hadoop应用案例分析

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

Hadoop 大数据技术原理与应用

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

大数据-Hadoop应用

一、初识Hadoop 以一个小故事解释什么是Hadoop&#xff1a; 小明接到一个任务&#xff1a;计算一个100M的文本文件中的单词的个数&#xff0c;这个文本文件有若干行&#xff0c;每行有若干个单词&#xff0c;每行单词与单词之间均以空格键隔开。对于处理这种100M量级数据的计…

Spark应用场景以及与hadoop的比较

Spark应用场景以及与hadoop的比较 一、大数据的四大特征: a.海量的数据规模(volume) b.快速的数据流转和动态的数据体系(velocity) c.多样的数据类型(variety) d.巨大的数据价值(value) 二.Spark 和 Hadoop的不同 Spark是给予map reduce 算法实现的分布式计算,拥有Ha…