TODL

一个用于查找源代码中注释标签的工具。

你喜欢在代码中留下待办注释，但又想轻松找到它们吗？使用 grep！但如果你想使用不同类型的标签（优化、修复、错误等），想获取更多信息（注释最后更改的时间）或者你只是比较懒惰，那么 todl 可以帮助你。

安装

您可以将 todl 作为命令行工具安装

cargo install todl

用法

搜索当前目录

todl

示例输出（宽度由您的终端决定）

常见问题解答

注释标签是什么？

注释标签是位于注释开头以便更容易查找和传达意义的标签。

// TODO: Make this function do something
fn foo() -> u32 {
    0
}

维基百科注释标签

支持哪些注释标签？

C 风格注释和 Rust todo!() 宏。

支持的标签包括（不区分大小写）

todo
bug
debug
fix
fixme
note
nb
undone
hack
bodge
kludge
xxx
optimize
optimizeme
optimise
optimiseme
safety
invariant
lint
ignored

如果我的注释不受支持怎么办？

支持自定义标签，但如果您使用的是目前不受支持的编程语言，请在此处提出问题 issues。

限制

• 目前仅支持 Rust 和 C 类语法
• 不排除字符串
• 注释标签之后提取的消息仅包括第一行

替代方案

查看这些执行类似操作的工具

• cargo-todo
• todo-ci