前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >IDEA注释详解_idea自定义注释模板

IDEA注释详解_idea自定义注释模板

作者头像
全栈程序员站长
发布于 2022-11-11 13:07:16
发布于 2022-11-11 13:07:16
1.4K00
代码可运行
举报
运行总次数:0
代码可运行

大家好,又见面了,我是你们的朋友全栈君。

目录

最近从eclipse转idea了,第一步当然是配置快捷键,模板等。但是!发生了一件贼蛋疼的事情,竟然一直找不到正确添加方法注释的方法! 最后自己摸索到了,在此详细记录,供大家参考。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
测试版本为idea for mac,可能快捷键不同,但是设置等肯定是相同的
  • 1
  • 2

生成类注释

  1. 打开Preferences
  2. Editor -> File and Code Templates -> Files -> Class
  1. 效果图

网上很多都是在Includes的File Header里面添加,在这里面添加还需要自己去移动下鼠标,然后再去操作键盘,再去写description,,直接在创建类的时候就添加好description不更快吗?

  • 在此添加的话你每次创建类的时候会弹两次框,第二次是让你输入description的内容了,so, 这就是最优的方法

  1. 同理,也可以在这儿为你的Interface,Enum添加上注释

生成类注解模板

代码语言:java
AI代码解释
复制
/** * @program: ${PROJECT_NAME} * * @description: ${description} * * @author: Mr.Wang * * @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE} **/
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

这里的代码区显示有问题,csdn有bug ,去掉里面的中文就行了。

生成方法注释

  1. 打开Preferences
  2. Editor -> Live Templates -> 点击右边加号为自己添加一个Templates Group -> 然后选中自己的Group再次点击加号添加Live Templates
  1. 然后设置自己喜欢的快捷键 在Abbreviation里面 记得在Applicable in 里面勾选,起码也要勾选class
  1. 然后在Edit variables里面添加参数和返回值的自动取值

Expression里面选择就是了

  1. 然后再你的方法上面直接输入/ + 你设置的Abbreviation快捷键 + tab键就直接生成了 (我设置的是/+ a + tab) 效果图:

里面的参数和返回值都是根据你在Edit variables里面添加的自动生成的,

生成方法注解模板

** * @Description: description * @Param: params * @return: returns * @Author: Mr.Wang * @Date: date */

注意,这个和类注解模板有点不一样,这个是用两个$$ ,这个的作用就是生成后光标直接跳到当前位置,这样也可以直接去输入description的内容了 对于 Live Templates只能说真的很强大,你平常用的sout ,psvm什么都是里面的,大家可以自行百度一下学习一下。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

发布者:全栈程序员栈长,转载请注明出处:https://javaforall.cn/187594.html原文链接:https://javaforall.cn

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2022年9月30日 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 目录
    • 生成类注释
      • 生成类注解模板
    • 生成方法注释
      • 生成方法注解模板
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档