Python TODO 注释规范 | Google 官方待办写法

TODO (待办) 注释

Tip：
在临时、短期和不够完美的代码上添加 TODO (待办) 注释。

待办注释以 TODO (待办) 这个全部大写的词开头，紧跟着是用括号括起来的上下文标识符（最好是 bug 链接，有时是你的用户名）。最好是诸如 TODO(https://crbug.com/<bug编号>): 这样的 bug 链接，因为 bug 有历史追踪和评论，而程序员可能发生变动并忘记上下文。TODO 后面应该解释待办的事情。

统一 TODO 的格式是为了方便搜索并查看详情。TODO 不代表注释中提到的人要做出修复问题的保证。所以，当你创建带有用户名的 TODO 时，大部分情况下应该用你自己的用户名。

## TODO(crbug.com/192795): 研究 cpufreq 的优化.
## TODO(你的用户名): 提交一个议题 (issue), 用 '*' 代表重复.

如果你的 TODO 形式类似于”将来做某事”，请确保其中包含特别具体的日期（“2009年11月前解决”）或者特别具体的事件（“当所有客户端都能处理 XML 响应时，删除这些代码”），以便于未来的代码维护者理解。