编程是代码和注释的统一；
TODO 自然表示需要做而未做的一些待完成的事项，有助于事后的检索，以及对整体项目做进一步的修改迭代。
# TODO(): Use a "*" here for string repetition. # TODO(Zeke) Change this to use relations.最好在注释中包含一个截止日期（“2009年11月解决”）或等待一个特定事件的发生（“等到所有的客户都可以处理XML请求就移除这些代码”）。
一些基本要求和规范：
- TODO注释应该在所有开头处包含”TODO”字符串,
- 紧跟着是用括号括起来的你的名字, email地址或其它标识符.
- 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么. 主要目的是为了有一个统一的TODO格式,
- 这样添加注释的人就可以搜索到(并可以按需提供更多细节).
在 PyCharm 中，使用 Alt + 6 快捷键，可快速调出项目中的全部 TODO 注释；
- Working with TODO in PyCharm
- Python风格规范
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请联系我们举报，一经查实，本站将立刻删除。
发布者：全栈程序员-站长，转载请注明出处：https://javaforall.net/173663.html原文链接：https://javaforall.net
