【转】IDEA类和方法注释模板设置(非常详细)
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
【转】IDEA类和方法注释模板设置(非常详细)相关推荐
- IDEA类和方法注释模板设置(非常详细、实用)
点个赞,看一看,好习惯!本文 GitHub https://github.com/OUYANGSIHAI/JavaInterview 已收录,这是我花了 3 个月总结的一线大厂 Java 面试总结,本 ...
- IDEA类和方法注释模板设置
这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置: 类注释模板: /**** @ClassName: TestType* @Descriptio ...
- IntelliJ IDEA 2022 类和方法注释模板设置
一.概述 IDEA自带的注释模板一般都很简单,然而我们在写代码的时候喜欢把类注释和文档注释写在代码里,既方便自己看所有的参数,也便于以后维护代码的时候看到编码作者.下面是我的代码注释,我们就按照这种格 ...
- IDEA方法注释模板设置
IDEA类和方法注释模板设置 1.File–>Settings–>Editor–>Live Templates (1)新建组:命名为userDefine (2)新建模板:选中你刚才创 ...
- idea方法注释模板设置完了,不显示
idea方法注释模板设置完成之后,写了一个方法,但是上面的注释没有自动生成, 此时在方法上面 另起一行, 输入 add(输入add字母就行),然后按下tab键,注释就自动生成了.
- IntelliJ IDEA类和方法注释模板配置
1.设置文件注释 设置Java类的注释模板,创建Java类自动生成该注释模板. 先看文件注释效果: 1.1.选择 IntelliJ IDEA -> 选择 Preferences... 打开IDE ...
- IDEA设置类、方法注释模板
类注释模板 File -> Other Setting -> Default Setting打开默认设置 Editor -> File and Code Templates -> ...
- Idea 设置类、方法注释模板(解决params和return显示问题)---不来虚的 实测有效
目录 1.使用场景 2.操作步骤 2.1.新建类模板注释添加 2.2.给类的方法生成方法注释 3.成果展现 4.参考文章 1.使用场景 我们在开发项目的时候需要知道类的创建者,什么时间创建,这个类是什 ...
- idea设置Java类和方法注释模板
1.创建类/接口时,自动生成注释模板 按照步骤(mac版本):IntelliJ IDEA->Preferences->Editor->File and Code Templates- ...
- IDEA类和方法注释模板
先看效果 类 创建类的时候先描述这个类干啥用的 方法 先说创建类的注释模板 选择class 类注释模板 /** * * @description ${description}* @date ${DAT ...
最新文章
- 使用Redis分区将数据分割到多个Redis实例
- Jmeter加Fiddler对web项目测试
- 前端工程师必备:学习资源全网罗
- Android中WebService的应用
- android从一点展开动画,Android自定义View——从零开始实现可展开收起的水平菜单栏...
- 解决文件夹无限嵌套无法删除的问题---最新办法
- 无人机路径规划算法_无人机集群——航迹规划你不知道的各种算法优缺点
- 典型飞行控制系统的回路构成
- 四、Raid卡(阵列卡)
- 汽车行业DMS系统介绍
- 项目结构优化设计之smv架构
- Unity精华☀️二、到底是什么原因导致“万向锁”?旋转翻车的终极解析!
- Graphics2D 在一张图片上添加一个带有透明背景的图片或绘制透明图片
- 换了工作城市,社保和公积金的转移
- OMRON欧姆龙PLC如何实现远程上下载程序?
- Windows下启动单机kafka出现:系统找不到指定路径
- 基于RTSP的流媒体播放器制作(2)
- 【Pandas】数据结构Series 基本用法总结
- VMware虚拟机屏幕太小,解决方案(windows)
- Internet互联网络提供的主要服务
热门文章
- 【运输量预测】基于matlab多种算法公路运输量预测【含Matlab源码 041期】
- 2060显卡驱动最新版本_堪比显卡界中的小米,价格屠夫,1999的铭瑄RTX2060终结者体验...
- 回答问题人工智能源码_回答21个最受欢迎的人工智能问题
- ai第二次热潮:思维的转变_基于属性的建议:科技创业公司如何使用AI来转变在线评论和建议
- 鸿蒙升级最佳时间,鸿蒙升级时间确定,17款华为优先,荣耀或成遗珠!
- python:whl包离线下载,pip离线安装whl文件
- html读取本地json数据库,用Javascript读取本地JSON到HTML
- springboot内置浏览器_springboot-为内置tomcat设置虚拟目录
- python获取文件列表失败_python – Pytesseract没有这样的文件或目录错误
- linux hdfs授予文件夹权限,修修改hdfs上的文件所属用户、所属组等读写执行控制权限...