了解todo

表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc 还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个 Javadoc 标签）。

在项目中我们应该鼓励使用todo, 可以记录未完成事项, 比如后期的优化工作; 当前遗漏的场景等等, 不然很容易忘记这些该做的事情

自定义todo快捷方式

  1. 首先打开File–>Settings–>Editor–>Live Templates

  2. 点击右边的“+”号,点击Template Group… (图中包含了第三步) 添加一个user (名字随意)

在这里插入图片描述

  1. 点击user，再次点击右边的“+”号，点击Live Templates，编辑快捷键名字，添加说明，添加TODO格式

    1698375876904

  2. 点击Edit variables编辑变量 (没有变量可以跳过)

    在这里插入图片描述

  3. 测试：在需要写TODO的地方直接打td就会有提示了

    在这里插入图片描述

案例:

// todo $desc$ xkj $date$

$desc$ 表示一个变量, 可以为它设置函数, 不设置默认光标会停在这,等待输入

$date$ 表示一个变量, 为它设置函数, 自动生成时间

按照阿里的规范, 还需要有 标记人，标记时间，[预计处理时间]

完整版: // todo $desc$ xkj $date1$ $date2$

其中$date1$和$date2$可以设置函数, 自动生成时间

同理还可以设置 fixme

设置TODO过滤器

  1. 查看todo行

    在这里插入图片描述

这里默认会把项目中所有的todo都展示出来, 有时todo太多, 会影响观看, 所以需要过滤

  1. 添加自定义的过滤器

在这里插入图片描述

  1. 定义模板

    在这里插入图片描述

解释一下上面模式啥意思：它就是两个正则表达式，“正则中“\b”是元字符代表着单词的开头或结尾，也就是单词的分界处。现在我们看上面两个正则表达式“\b \b"中字符串：ZSH TODO,该表达式单纯表达的意思就是匹配ZSH TODO.*

这里规则使用: \btodo\b.*\b*xkj\b.*

表示匹配 以todo开头, 中间含 ‘xkj’ 字符的

  1. 添加过滤器

在这里插入图片描述

  1. 使用todo过滤器

在这里插入图片描述

IDEA中TODO的使用、配置和设置TODO过滤器_idea todo-CSDN博客