Python TODO说明

一. Python TODO说明

TODO主要是为了说明待做任务，一般标明任务人、任务时间、任务人联系方式等信息。

二. TODO使用规范

1. TODO注释应该在所有开头处包含”TODO”字符串, 紧跟着是用括号括起来的你的名字, email地址或其它标识符。
2. 然后是一个可选的冒号。接着必须有一行注释, 解释要做什么。
3. 如果你的TODO是”将来做某事”的形式, 那么请确保你包含了一个指定的日期(“2009年11月解决”)或者一个特定的事件(“等到所有的客户都可以处理XML请求就移除这些代码”)。
4. 写了TODO注释并不保证写的人会亲自解决问题. 当你写了一个TODO, 请注上你的名字。

三. TODO使用示例

# TODO(12345@qq.com): 完成模型部署开发任务（2019/10/1）
# TODO(张三) 机器学习平台二次开发任务 

四. 使用TODO的目的

1. 为了有一个统一的TODO格式, 这样添加注释的人就可以搜索到(并可以按需提供更多细节)。

五. PyCharm中使用TODO

注： PyCharm中 alt+6 快捷键能显示全部TODO信息

六. 参考

1. Python使用风格
2. PyCharm中使用TODO