快qt速注释快捷键_小小TODO标识注释

本文介绍了如何在IntelliJ IDEA中利用默认和自定义TODO注释来跟踪代码中的待办事项,强调了其在代码管理中的重要性。通过设置,可以创建特定模式的TODO,便于搜索和高亮显示。使用TODO工具窗口,可以按不同范围查看待办事项,同时可通过过滤器和Live Template进行高效管理。最后,提倡定期清理和优化TODO,以保持代码整洁。
摘要由CSDN通过智能技术生成
6acc1c9931b8e33d3f39401f382277b5.gif

前言

有时,您需要标记部分代码以供将来参考,比如: 优化,改进,可能的更改,要讨论的问题等。通常我们会在代码中加入如下的标记表示待办:

//TODO 我将要在这里做 xxx

你这样做,别人也会这样做。一时间,项目中可能会存在大量的 TODO,当你搜寻你的 TODO 时也就变得非常麻烦,如同石沉大海,也就失去了这个标记的意义。

IntelliJ IDEA允许我们添加特殊类型的注释,使得这些注释在编辑器中突出显示,它们被索引,并在 TODO 工具窗口 中列出。这样,我们就容易追踪自己的 TODO 了。

5be2f4f990362c67c232385f1b7c04de.png

默认的 TODO

默认情况下,IntelliJ IDEA识别两种模式:小写和大写的 TODOFIXME 这些模式可在任何受支持文件类型的行注释和块注释内部使用。我们可以根据需要修改默认模式或添加自己的模式

如上图,我们可以创建多行的 TODO (类似 Spring Boot 中的 YAML 配置多个值),需要缩进第一行之后的注释行。如果没有缩进,则将行视为常规注释行

要禁用多行 TODO 项目,使用快捷键 ⌘ + , 打开 Preferences, 搜索 TODO (Editor | TODO), 你会看到如下界面

2236298b3334040352086b1b6f475e8a.png

要查看系统中的所有 TODO,请打开 TODO 工具窗口 (快捷键 ⌘ + 6 )。切换选项查看 TODO 范围:

  • 从当前项目中的所有文件
  • 仅基于当前文件的范围
  • 指定范围的文件
  • 活动的变更列表
ab43e1cfb53357381911600b8a96225b.png

到这里 Intellij IDEA 默认提供的 TODO 就介绍完了,为了能更快的找到我们自己的 TODO,我们就需要进行自定义

自定义 TODO

重新打开 TODO 位置,新增 TODO item,这里新增 optimize,用于标识待优化内容

14d2809a4d568a0a088f047242c9a4ef.png

添加个过滤器,用于 TODO 的分组f4a2fa8cbd00f3ba1ef776dce6fc974e.png

随便添加一个优化备注,通过以上介绍的功能,快速定位到我们自己的 TODO

8f279f516914e6efee6dcb1512007b87.png

如果你的待办事项通常是相对固定的描述,你也可以配合 Live Template 快速生成 TODO 内容

高清大图,请查看原文

总结

当团队规模很大,你又同时有很多待办的时候,TODO 特性可以帮助我们做标识,自定义 TODO 可以帮我们快速定位,我们可以充分利用这个特性,但是

定期清理 TODO

8c9c4958fed2a0d2d9f03cfccdbcf301.png

灵魂追问

  1. 你觉得项目中代码有哪些不规范/不够整洁的地方?(欢迎到博客下方留言讨论)

a386f3f2376932f2f5a19db1df822997.gif
  • 一张图帮你记忆,Spring Boot 应用在启动阶段执行代码的几种方式
  • 在SpringBoot内如何使用ApplicationEvent&Listener完成业务解耦?
  • Java equals 和 hashCode 的这几个问题可以说明白吗?
  • SpringBoot如何优雅的校验参数
  • 如何妙用Spring 数据绑定机制?
bef51f6960d7bfe8eb656f8a61dbe128.gif
3ba3d8c0bff7e120e6c73985feccc562.png
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值