详细:idea如何设置文件头注释和方法注释

IDEA类和方法注释模板设置(非常详细) 阅读详情
AI摘要

本文介绍如何在IntelliJ IDEA中配置类头和方法注释模板,包括自定义注释格式、参数获取方式及应用场景设置。

idea:

类头注释:打开file->setting->Editor->Filr and Code Templates->Includes->File Header 
这里写图片描述
直接在右边的文件框里编辑你说需要注释的东西,然后应用保存之后,当你创建类的时候就会自动生成注释。

方法注释:打开file->setting->Editor->LiveTemplates点击右边上面那个绿色的+号,选择Template Group双击,然后弹出一个窗口,随便添加一个名字,我这里添加的是MyGroup然后点击OK 
这里写图片描述

还是在file->setting->Editor->LiveTemplates这个路径下点击一下刚刚你添加的那个名字(我这是MyGroup),然后点击右边上面那个绿色的+号,选择LiveTemplate双击,填写下面的图上的框 
这里写图片描述
然后点击这里写图片描述 
然后选择Everywhere 
这里写图片描述

最后点击右下角的Edit variables 按钮,然后弹出一个窗口,如下: 
这里写图片描述
如果想把 @param:每一个参数可以这样 
这里写图片描述
参数值要自己写的

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

把这个添加进去,但是还要注意一点: 
这里写图片描述 
下面红色圈中的下拉框选择相对应的参数点击OK 
再点击apply,点击Ok。 

然后写方法之前点写上add(刚刚填的)按tab,注释就出来了。


第二篇

-------------------------------------------------------------------------------------

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)设置模板:模板内容如下

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

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

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

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

选择右侧的Edit variables按钮

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

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

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

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

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

(7)效果图

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



实战篇【2】-H3C防火墙开局基础配置 本篇文章为“H3C防火墙开局基础配置”,主要涵盖配置管理地址、聚合端口、安全区域、安全策略、静态路由、ACL,WEB和SSH远程管理、Console、SNMP、NTP时钟、日志主机等内容,对比交换机配置开局,增加两处配置,安全区域和安全策略。方便调试人员远程管理、调试。 阅读详情

相关推荐

揭秘大型语言模型:从神经元到思维透明的奇妙旅程

这篇博客带你走进大型语言模型的内部世界,从神经元的小任务,到功能向量的团队合作,再到层间的协作和思维的透明化。掌握这些知识,能让你在开发中更高效地优化AI,在研究中更深入地探索模型的奥秘。建议多动手实践,把这些理论变成自己的能力!

数据与算法架构提升之路专栏 1519

IDEA中如何设置文件头注释和方法注释(详解)

文件头注释和方法注释的两种方式 方法一: 文件头注释: 打开File–>Settings–>Editor–>File and Code Templates–>includes–>File Header 1.第一步点击File 2.找到File中的Settings 3.Settings去找到Editor中的File and Code Templates后 4.找到includes去添加File Header 5.最后在右边的编辑栏里进行注释需要编辑的内容 6.以上操作完成后

qq_54769967的博客 2万+

二、基于C语言的JPEG解码代码详解

// JPEG解码 // 输入JPEG后输出Bitmap #include <stdio.h> #include <stdlib.h> #pragma warning(disable : 4996) unsigned int BuffIndex; // JPEG数据的位置 unsigned int BuffSize; // JPEG数据的大小 unsigned int BuffX; // 图像的横向尺寸 unsigned int BuffY; //

m0_37633745的博客 4451

IDEA自定义文件头注释/方法注释

IDEA自定义文件头注释/方法注释

Heavenly Grace的博客 2690

MATLAB 论文复现——面向电量-调频-容量市场的数据中心园区算力及电力资源规划

如何在保证数据中心服务质量的前提下,考虑数据中心负荷转移特性,并对其进行合理规划,对降低数据中心规划总成本及提升新型电力系统灵活性均有显著意义。然后,根据不同电力市场的结算规则,研究了数据中心园区参与电量-调频-容量市场的方式和经济收益。在此基础上,以综合成本最小化为目标,优化数据中心园区发电机、储能的建设容量以及服务器的建设数量。最后,以阿里巴巴公开运行数据为例,证明考虑多元电力市场能够大大降低数据中心规划成本,激励数据中心园区投资建设更多灵活性资源,为电网提供有效的调频服务和容量支撑。

sjr1478的博客 664

【HDLBits实战】从真值表到最优电路:SOP与POS形式在ECE241考题中的精妙应用

本文以HDLBits平台上的ECE241考题为例,详细讲解了如何从真值表出发,利用卡诺图化简技术,推导出最优的积之和(SOP)与和之积(POS)逻辑表达式。文章重点剖析了如何处理“无关项”以简化电路,并通过Verilog代码实现对比,阐述了SOP与POS形式在数字电路设计中的精妙应用与实战价值。

z2a3b4c5d的博客 214

idea设置类、接口和枚举的注释模板

设置类、接口和枚举的注释 打开Settings后,选择Editor -> File and Code Templates -> Files -> Class: 增加以下模板: /** * @description: ${description} * @version: 0.0.1 * @author: * @createTime: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} **/ ...

快哉此风的博客 1059

Datawhale~数据挖掘实践之序列问题处理~天池·资金流入流出预测-挑战Baseline~Day01~数据探索与分析

写在前面✍ 本系列笔记基于天池平台上“资金流入流出预测-挑战Baseline”学习赛,记录如何完整的打一次数据挖掘类比赛。同时,该比赛属于序列建模问题,希望学习完成这个任务,可以对序列问题的处理有一定的独立思考能力和实践操作能力,可以将所学理论,用编码的形式和实际的问题得到深入。 第一篇,EDA Content: 初步了解赛题及数据 1.1 任务 1.2 用户基本信息数据 1.3 用户申购赎回数据 1.4 收益率表 1.5 银行间拆借利率表 1.6 提交格式 1.7 评分指标 EDA 1 初.

小卜妞的博客 2358

idea 设置文件注释头信息

idea 设置文件注释头信息

qq_52102677的博客 1081

ParaView: 从 2 或 3 个标量创建向量

ParaView: 从 2 或 3 个标量创建向量

希望我的博客,能帮上你解决学习中工作中所遇到的问题 583

工程师必读一次性讲明白系列(十三)眼图、阻抗匹配、信号一致性、射频匹配、电磁感应

概念主要作用影响因素解决方法眼图评估信号质量,显示失真和噪声噪声、信号失真、时序抖动改善信号源、使用低噪声组件阻抗匹配避免信号反射,提高传输效率阻抗不匹配、传输线路特性使用匹配电路、适配器信号一致性保证信号稳定准确传输传输线路、噪声干扰使用屏蔽、滤波器,选择合适线路射频匹配确保射频信号高效传输天线设计、阻抗不匹配使用射频匹配器、调整天线设计电磁感应防止电磁干扰对信号的影响设备之间的电磁干扰(EMI)屏蔽、接地、滤波器。

weixin_43199439的博客 156

Idea设置注释

Idea注释设置笔记

想混口饭&的博客 1万+

大厂面经:京东大数据面试题及参考答案(3万字长文)

Kafka是一个开源的分布式流处理平台,由 LinkedIn 开发并在 2011 年贡献给 Apache 软件基金会。高吞吐量:能够处理大量的数据流,适合实时数据管道。持久性:数据存储在磁盘上,确保数据不丢失。容错性:通过数据复制提供高可用性。扩展性:支持水平扩展,易于增加更多节点。Kafka 的核心概念Topic:逻辑上的数据流,可以理解为主题。Producer:生产数据的应用程序。Consumer:消费数据的应用程序。Broker:Kafka 集群中的服务器节点。Partition。

大模型大数据攻城狮的专栏 862

IDEA在新建的类文件开头自动加注释信息以及描述信息

2、依次打开:File----->Settings----->Editor----->File and Code Templates----->Files----->Class。

m0_52445307的博客 3139

Statistics and Machine Learning Toolbox

Statistics and Machine Learning Toolbox(带书签),MATLAB统计学习工具

jdk-8u144-linux-x64.tar.gz.

该资源为搭建Linux系统Java环境用,资源的后缀为tar.gz格式的压缩包

【idea技巧篇】idea的类注释和方法注释模版自定义设置

这块idea技巧虽然常用,谁没事会经常修改模版设置呢,一般是搭建开发环境的时候或者开发规范要求等设置一次就行了。用的虽然少,但几乎每次搭建环境都会用到,这里记录下并分享设置的过程已经发现的更高级的一些使用技巧。

分享技术,记录思考和感悟 4929

STM32F407中文手册

STM32f407中文手册 本参考手册面向应用开发人员,提供有关使用 STM32F405xx/07xx、STM32F415xx/17xx、 STM32F42xxx 和 STM32F43xxx 微控制器存储器与外设的完整信息。STM32F405xx/07xx、STM32F415xx/17xx、STM32F42xxx 和 STM32F43xxx 构成一个微 控制器系列,各产品具有不同的存储器大小、封装和外设。有关订购信息以及器件的机械与电气特性,请参见数据手册。有关 ARM Cortex™-M4F 内核的信息,请参见《Cortex™-M4F 技术参考手册》。

IntelliJ IDEA文件头注释模板

设置路径: File-Other Settings-Default Settings-Editor-File and Code Templates-Includes-File Header 模板代码: /** * Created with IntelliJ IDEA. * Description: * User: ${USER} * Date: ${YEAR}-${MONTH}-${DA

totally123的专栏 2万+

详细:idea如何设置类头注释和方法注释

idea和eclipse的注释还是有一些差别的。idea:类头注释:打开file->setting->Editor->Filr and Code Templates->Includes->File Header 直接在右边的文件框里编辑你说需要注释的东西,然后应用保存之后,当你创建类的时候就会自动生成注释。方法注释:打开file->setting->Editor->LiveTemplate

u013412790的专栏 28万+

IDEA设置类注释和方法注释的详细操作步骤

平时写代码的时候除了要写单行注释之外,还会写类注释和方法注释,详细介绍一下如何在IDEA中设置类注释和方法注释。

Java领域优质创作者,华为云享专家 5364

Intellij IDEA设置@Author文件头注释

版权声明:本文为博主原创文章,未经博主允许不得转载。https://blog.youkuaiyun.com/qq_42680327 今天小编刚刚开始学习用idea的时候,跟着师兄的两小时学会SpringBoot的视频,看着idea可以自动生成@author文件头注释,可以生成写程序的当前日期,于是就写下这篇文章,感兴趣的可以跟着我后面一起设置,直接看下面: 1、右击File -> Settings ...

qq_42680327的博客 2万+

IDEA 设置类注释和方法注释模板

IDEA 设置类注释和方法注释模板简介IDEA的设置注释新建类、接口、枚举时新建模板注释,注释类 简介 通常,在创建一个新的类、接口或方法时,我们都会给它加上注释。虽然在添加注释时会花掉一小部分时间,但是在后面进行代码维护/交接时可以更快速的完成维护/交接工作。既然决定要写注释了,那就不能潦草的为了完成工作,必须能让自己以后看得懂,让同事也能看得明白。 IDEA的设置注释 新建类、接口、枚举时 在新建类、接口、枚举…时,我们可以直接让IDEA再创建文件时一并将文件注释创建好 右侧的模板代码可以根据自我喜好进

19:30的博客 5446
上一篇: File协议
下一篇: Linux下4个查找命令which、whereis、locate、find的使用与区别
shadow_zed
博客等级 码龄10年 6289粉丝 68原创
评论 7
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值