博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Intellij IDEA神器常用技巧四-类和方法注释模板设置
阅读量:6871 次
发布时间:2019-06-26

本文共 1292 字,大约阅读时间需要 4 分钟。

hot3.png

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

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

类注释模板:

1

方法注释模板: 2

首先我们来设置IDEA中类的模板

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

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

  • ${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名
  • TODO:代办事项的标记,一般生成类或方法都需要添加描述
  • ${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}
  • 1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了

3

效果图展示

4

设置方法注释模板

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

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

File-->Settings-->Editor-->Live Templates

5

新建组:命名为userDefine

6

新建模板:命名为*

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

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

获取方法返回值的methodReturnType()

7

  • 设置生成注释的快捷键

8

  • 设置模板:模板内容如下

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

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

9

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

10

  • 设置参数的获取方式

选择右侧的Edit variables按钮

11

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

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

12

  • 设置模板的应用场景

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

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

13

14

  • 效果图

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

15

本文作者:xiaoliulang0324

原文链接:
版权归作者所有,转载请注明出处


欢迎关注博主公众号,Java十分钟,每天十分钟,一起学习Java

欢迎关注博主公众号

往期精彩:

转载于:https://my.oschina.net/Mkeeper/blog/1833669

你可能感兴趣的文章
《Adobe Photoshop CC经典教程(彩色版)》—第1课1.4节在Photoshop中还原操作
查看>>
HttpClient使用详解
查看>>
增强现实?先不要指望那些眼镜了
查看>>
《iOS 6核心开发手册(第4版)》——1.10节秘诀:使用多触摸交互
查看>>
《云数据管理:挑战与机遇》一第1章
查看>>
《嵌入式C编程实战》——1.5 软件开发工具
查看>>
分析3000份技术面试数据:这几大指标比你毕业于哪所学校更要紧
查看>>
Linux有问必答:如何检查PDF中使用了哪种字体
查看>>
《Lua游戏AI开发指南》一2.1 新建一个沙箱项目
查看>>
如何使用 Weave 以及 Docker 搭建 Nginx 反向代理/负载均衡服务器
查看>>
《Android 应用测试指南》——第1章,第1.4节测试的种类
查看>>
对jquery val 获取input 文本框值进行扩展
查看>>
MySQL (select_paren) union_order_or_limit 行为
查看>>
并发不是并行,它更好!
查看>>
nltk 自己训练模型例子
查看>>
间谍卫星的基础?YOLT——利用卷积神经网络对卫星影像进行多尺度目标检测(Part I)...
查看>>
jstl_开发第一个标签
查看>>
程序员哇,你想在下个情人节或者520脱单么?这个秘籍不能错过
查看>>
去不去O,谁说了算?
查看>>
PHP防SQL注入和XSS攻击
查看>>