python: TODO 助记符

概述

TODO 在 python 中作为一种 助记符 (Mnemonics)，用来解释 将要做什么 。

制定于 PEP 350 – Codetags 。

Syntax

TODO: Informal tasks/features that are pending completion.

例如：

可以在 TODO 里注上自己的名字：

# TODO(jn@gmail.com): Use a "*" here for string repetition.
# TODO(JN) Change this to use relations.

也可以在 TODO 里制定完成的日期：

i = i + 1   # TODO Add some more codetags.
# <JN 2017-11-23 d:2017-11-23 t:XXX d:14w p:0 s:inprogress>

Ref:

• PEP 350 – Codetags
• Python风格规范