编程是代码和注释的统一;
TODO
自然表示需要做而未做的一些待完成的事项,有助于事后的检索,以及对整体项目做进一步的修改迭代。
# TODO([email protected]): Use a "*" here for string repetition.
# TODO(Zeke) Change this to use relations.
- 1
- 2
最好在注释中包含一个截止日期(“2009年11月解决”)或等待一个特定事件的发生(“等到所有的客户都可以处理XML请求就移除这些代码”)。
一些基本要求和规范:
- TODO注释应该在所有开头处包含”TODO”字符串,
- 紧跟着是用括号括起来的你的名字, email地址或其它标识符.
- 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么. 主要目的是为了有一个统一的TODO格式,
- 这样添加注释的人就可以搜索到(并可以按需提供更多细节).
在 PyCharm 中,使用 Alt + 6 快捷键,可快速调出项目中的全部 TODO 注释;
再分享一下我老师大神的人工智能教程吧。零基础!通俗易懂!风趣幽默!还带黄段子!希望你也加入到我们人工智能的队伍中来!https://blog.csdn.net/jiangjunshow