小小TODO标识,你用对了吗?

简介: 小小TODO标识,你用对了吗?

前言


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


//TODO 我将要在这里做 xxx


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


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


默认的 TODO


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


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


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


微信图片_20220510161022.jpg


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


  • 从当前项目中的所有文件


  • 仅基于当前文件的范围


  • 指定范围的文件


  • 活动的变更列表


微信图片_20220510161045.jpg


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


自定义 TODO


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


微信图片_20220510161129.jpg


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


微信图片_20220510161200.jpg


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


微信图片_20220510161219.jpg


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


高清大图,请查看原文:小小TODO也有大道理


总结


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


定期清理 TODO

微信图片_20220510161245.png


相关文章
|
Go
说到内嵌命名冲突,他直接把我虐哭了......
说到内嵌命名冲突,他直接把我虐哭了......
108 0
|
3月前
|
Linux Docker 容器
10-24|如果我这两个都配置了privileged:true我后边加的这个管用吗
10-24|如果我这两个都配置了privileged:true我后边加的这个管用吗
|
前端开发
前端学习笔记202304学习笔记第六天-样式冲突-无法声明未使用的props
前端学习笔记202304学习笔记第六天-样式冲突-无法声明未使用的props
38 0
|
存储 安全 算法
《我要进大厂》- Java基础夺命连环14问,你能坚持到第几问?(Object类 | String类)(一)
《我要进大厂》- Java基础夺命连环14问,你能坚持到第几问?(Object类 | String类)
《我要进大厂》- Java基础夺命连环14问,你能坚持到第几问?(Object类 | String类)(一)
|
Web App开发 前端开发 JavaScript
重学前端 20 # try里面放return,finally还会执行吗?
重学前端 20 # try里面放return,finally还会执行吗?
138 0
重学前端 20 # try里面放return,finally还会执行吗?
|
前端开发
#yyds干货盘点 【React工作记录九】switch对按钮进行判断操作
#yyds干货盘点 【React工作记录九】switch对按钮进行判断操作
108 0
|
存储 安全 算法
《我要进大厂》- Java集合夺命连环14问,你能坚持到第几问?(集合概述 | List | Set | Queue)
《我要进大厂》- Java集合夺命连环14问,你能坚持到第几问?(集合概述 | List | Set | Queue)
《我要进大厂》- Java集合夺命连环14问,你能坚持到第几问?(集合概述 | List | Set | Queue)
|
Java 编译器
《我要进大厂》- Java基础夺命连环14问,你能坚持到第几问?(Object类 | String类)(二)
《我要进大厂》- Java基础夺命连环14问,你能坚持到第几问?(Object类 | String类)
《我要进大厂》- Java基础夺命连环14问,你能坚持到第几问?(Object类 | String类)(二)
try catch 应该放在for里还是不该放for里
try catch 应该放在for里还是不该放for里
115 0
|
前端开发 JavaScript
好客租房78-setState方法说明(3第二个参数)
好客租房78-setState方法说明(3第二个参数)
139 0