小小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


相关文章
|
12月前
|
Web App开发 前端开发 JavaScript
答网友提问:为什么语句 var oModel = this.stub() 是构造一个stub对象? stub()是一个函数,从哪里来的?
答网友提问:为什么语句 var oModel = this.stub() 是构造一个stub对象? stub()是一个函数,从哪里来的?
|
4月前
|
Java
【Java】— —实现人物对象的增、删、改、查(注:对象的删除以逻辑删除为主,在person类中设置“删除状态字段”,字删除该字段时,将状态改为有效。)
【Java】— —实现人物对象的增、删、改、查(注:对象的删除以逻辑删除为主,在person类中设置“删除状态字段”,字删除该字段时,将状态改为有效。)
|
4月前
|
搜索推荐 Java
TODO有什么妙用
`TODO` 是Java开发中用于标记未完成功能或待修复问题的注解,能帮助追踪和管理开发任务。在代码中添加 `// TODO` 标记,如 `// TODO do something`,之后可通过搜索快速定位。IDEA还支持自定义`TODO`类型和颜色,以及全局查看和过滤器功能。阿里巴巴开发手册建议使用 `TODO` 表示待实现功能,`FIXME` 标记错误代码。推荐创建个性化代码模板以提高效率。
|
4月前
|
存储 安全 网络安全
关于事务码 STRUST 里 Add to Certificate List 按钮灰色不可点击的问题分析
关于事务码 STRUST 里 Add to Certificate List 按钮灰色不可点击的问题分析
|
4月前
|
算法 Java 关系型数据库
jeecgboot中如何获取保存后数据的关键字ID
jeecgboot中如何获取保存后数据的关键字ID
68 0
|
4月前
|
人工智能 前端开发 程序员
TODO 标题待更改
TODO 标题待更改
|
前端开发
前端学习笔记202304学习笔记第六天-样式冲突-无法声明未使用的props
前端学习笔记202304学习笔记第六天-样式冲突-无法声明未使用的props
29 0
|
Java
java学习第十一天笔记-字符串217-根据id查找用户信息
java学习第十一天笔记-字符串217-根据id查找用户信息
71 0
java学习第十一天笔记-字符串217-根据id查找用户信息
|
小程序 开发工具 C#
微信公众号支付提示mch_id参数格式错误
微信公众号支付提示mch_id参数格式错误
561 0
|
JSON 前端开发 API
剥开比原看代码12:比原是如何通过/create-account-receiver创建地址的?
作者:freewind 比原项目仓库: Github地址:https://github.com/Bytom/bytom Gitee地址:https://gitee.com/BytomBlockchain/bytom 在比原的dashboard中,我们可以为一个帐户创建地址(address),这样就可以在两个地址之间转帐了。
1394 0