idea设置Java类注释和方法注释模板(javadoc规范)
1、类注释模板设置
File–>settings–>Editor–>File and Code Templates–>Files
添加模板:
简版:
/** * [一句话描述该类的功能]* @author : [${USER}]* @version : [v1.0]* @createTime : [${DATE} ${TIME}] */
复杂点的:
/** * @description : [一句话描述该类的功能] * @author : [${USER}]* @version : [v1.0]* @createTime : [${DATE} ${TIME}] * @updateUser : [${USER}] * @updateTime : [${DATE} ${TIME}] * @updateRemark : [说明本次修改内容] */
2、方法注释模板
方法注释模板用处不大,我一般用idea自带的。这里直接copy别人的当做备份了,侵删。
File–>Settings–>Editor–>Live Templates
(1)新建组:命名为userDefine
(2)新建模板:命名为*
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为
/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、
获取方法返回值的methodReturnType()
(3)设置生成注释的快捷键
(4)设置模板:模板内容如下
注意第一行,只有一个而不是/
在设置参数名时必须用 参 数 名 {参数名} 参数名的方式,否则第五步中读取不到你设置的参数名
** @author Sunny* @description //TODO $end$* @createTime ${DATE} ${TIME} * @param $param$* @return $return$**/
(5)设置模板的应用场景
点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere–>Java即可
(如果曾经修改过,则显示为change而不是define)
(6)设置参数的获取方式
选择右侧的Edit variables按钮
PS:第五步和第六步顺序不可颠倒,否则第六步将获取不到方法
选择每个参数对应的获取方法(在下拉选择框中选择即可),网上有很多教程说获取param时使用脚本的方式,我试过使用脚本
的方式不仅麻烦而且只能在方法内部使用注释时才能获取到参数
参考文档:
https://blog.csdn.net/xiaoliulang0324/article/details/79030752
https://www.cnblogs.com/felix-/p/4310229.html
idea设置Java类注释和方法注释模板(javadoc规范)相关推荐
- 如何在IDEA设置Java类和方法的注释模板?
如何在IDEA设置Java类和方法的注释模板? 1.类的注释模板设置 首先我们打开IDEA软件,进行如下操作:File–>Settings–>Editor–>File and C ...
- idea设置Java类和方法注释模板
1.创建类/接口时,自动生成注释模板 按照步骤(mac版本):IntelliJ IDEA->Preferences->Editor->File and Code Templates- ...
- idea设置类注释和方法注释(贼详细)
为了规范代码开发,我们需要用到开发工具的设置,比如类注释和方法注释的模板. 先说说在idea中如何设置类注释吧,第一步需要打开设置: 第二步打开文件和代码模板设置,并且找到类模板: /*** @Des ...
- IntelliJ IDEA设置类注释和方法注释模板
IntelliJ IDEA设置类注释和方法注释模板 1.设置类注释模板 这样在定义类时,都要多输入类的描述.不想的话,可以删去 ${description} 2.方法注释模板 先新建模板组,名字自己起 ...
- IDEA 设置类注释和方法注释模板
IDEA 设置类注释和方法注释模板 简介 IDEA的设置注释 新建类.接口.枚举时 新建模板注释,注释类 方法模板 记录工作中类模板设置 简介 通常,在创建一个新的类.接口或方法时,我们都会给它加上注 ...
- Intellj Idea 如何设置类头注释和方法注释
intellj idea 如何设置类头注释和方法注释 intellj idea的强大之处就不多说了,相信每个用过它的人都会体会到,但是我们也会被他的复杂搞的晕头转向,尤其刚从eclip ...
- IDEA设置类注释和方法注释的详细操作步骤
文章目录 [前言] [正文] 类注释 方法注释 测试 [前言] 平时写代码的时候除了要写单行注释之外,还会写类注释和方法注释,类似下图的效果: 下面介绍一下如何在IDEA中设置类注释和方法注释: [正 ...
- idea 类注释,方法注释设置
类头注释:打开file->setting->Editor->Filr and Code Templates->Includes->File Header 直接在右边的文 ...
- idea如何设置类头注释和方法注释
idea和eclipse的注释还是有一些差别的. idea: 类头注释:打开file->setting->Editor->Filr and Code Templates->In ...
- 详细:idea如何设置类头注释和方法注释
idea和eclipse的注释还是有一些差别的. idea: 类头注释:打开file->setting->Editor->Filr and Code Templates->In ...
最新文章
- 面试被问分布式事务(2PC、3PC、TCC),这样解释没毛病!
- Java实现有序数组和无序数组_【算法】字典的诞生:有序数组 PK 无序链表
- Python导入sciry包出错
- 在Spring、Hibernate中使用Ehcache缓存
- mfc 制作不同的文档模板mdi不同的子窗体_制作ACK集群自定义节点镜像的正确姿势...
- 在PyCharm中设置新建Python文件的模板格式方法
- V4L2 driver(一). 整体框架
- android boot.img 结构,android boot.img文件结构、拆包、打包
- 怎么改wps表格中折线图的横坐标?
- Frequently Asked Questions — Scrapy 0.15.1 documentation
- qt的qfiledialog怎么判断打开的是不是一张图片_花瓣网画板图片一键导出 设计师速来围观...
- OpenCV总结:图像增强算法实现(直方图均衡化、拉普拉斯、Log、Gamma)
- sql 纵向求和_sql 行列转换 求和平均值等
- 190422每日一句
- Atitit.java eval功能的实现 Compiler API
- 三星gsat笔试容不容易通过
- C语言 输出100以内的质数
- 系统无法以在此计算机上安装,windows无法完成安装若要在此计算机上安装怎么办...
- 2018“人工智能”:是彻底复苏?还是起落轮回?| 抢票
- TypeScript实现归并排序
热门文章
- AtCoder Beginner Contest 233
- HTML连载27-层叠性优先级!important用法
- python rgb2gray,COLOR_RGB2GRAY提供非灰度图像(可能是jupyternotebook的问题)
- cookie httponly ajax,HostOnly Cookie和HttpOnly Cookie
- 如何用Python在图片上绘制BoundingBox
- 微信放大招,100000个虎年最新红包封面来临,速度撸!
- 轻型社交圈系统交友及时聊天集成商城/语音聊天派对/交友广场,仿小红书
- js startsWith方法
- 一份品牌加入元宇宙的保姆级指南
- matlab高斯迭代法源程序,数值分析雅克比高斯迭代法MATLAB程序