小小TODO标识，你用对了吗？

前言

有时，您须要标记部分代码以供未来参考，好比: 优化，改进，可能的更改，要讨论的问题等。 一般咱们会在代码中加入以下的标记表示待办:

//TODO 我将要在这里作 xxx

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

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

默认的 TODO

默认状况下，IntelliJ IDEA识别两种模式：小写和大写的 TODO 和 FIXME 这些模式可在任何受支持文件类型的行注释和块注释内部使用。咱们能够根据须要修改默认模式或添加本身的模式

如上图，咱们能够建立多行的 TODO (相似 Spring Boot 中的 YAML 配置多个值)，须要缩进第一行以后的注释行。若是没有缩进，则将行视为常规注释行

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

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

• 从当前项目中的全部文件
• 仅基于当前文件的范围
• 指定范围的文件
• 活动的变动列表

到这里 Intellij IDEA 默认提供的 TODO 就介绍完了，为了能更快的找到咱们本身的 TODO，咱们就须要进行自定义

自定义 TODO

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

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

随便添加一个优化备注，经过以上介绍的功能，快速定位到咱们本身的 TODO

若是你的待办事项一般是相对固定的描述，你也能够配合 Live Template 快速生成 TODO 内容

高清大图，请查看原文：小小TODO也有大道理

总结

当团队规模很大，你又同时有不少待办的时候，TODO 特性能够帮助咱们作标识，自定义 TODO 能够帮咱们快速定位，咱们能够充分利用这个特性，可是

按期清理 TODO

灵魂追问

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

---

欢迎关注个人公众号 「日拱一兵」，趣味原创解析Java技术栈问题，将复杂问题简单化，将抽象问题图形化落地
若是对个人专题内容感兴趣，或抢先看更多内容，欢迎访问个人博客 dayarch.top