跳到内容

missing-todo-author (TD002)

源自 flake8-todos 代码检查器。

作用

检查 TODO 注释是否包含作者。

为什么这不好?

在 TODO 中包含作者可以为未来的读者提供有关问题的背景信息。虽然 TODO 作者不总是被认为有责任修复问题,但他们通常是对问题了解最多的人。

示例

# TODO: should assign an author here

建议改为

# TODO(charlie): now an author is assigned