跳到内容

无效 TODO 标签 (TD001)

源自 flake8-todos 代码检查器。

作用

检查 TODO 注释是否使用 “TODO” 标签。

为什么这不好?

含糊不清的标签会降低代码可见性,并可能导致悬而未决的 TODO。例如,如果注释使用 “FIXME” 而不是 “TODO” 标记,则可能会被未来的读者忽略。

请注意,此规则只会将 “FIXME” 和 “XXX” 标签标记为不正确。

示例

# FIXME(ruff): this should get fixed!

建议改为

# TODO(ruff): this is now fixed!