Pycharm使用笔记

本文是笔者使用 PyCharm 的笔记

TODO 注释
链接

TODO 注释

TODO注释应该在所有开头处包含”TODO”字符串, 紧跟着是用括号括起来的你的名字, email地址或其它标识符. 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么. 主要目的是为了有一个统一的TODO格式, 这样添加注释的人就可以搜索到(并可以按需提供更多细节). 写了TODO注释并不保证写的人会亲自解决问题. 当你写了一个TODO, 请注上你的名字.
1
2
# TODO(kl@gmail.com): Use a "*" here for string repetition.
# TODO(Zeke) Change this to use relations.
如果你的TODO是”将来做某事”的形式, 那么请确保你包含了一个指定的日期(“2009年11月解决”)或者一个特定的事件(“等到所有的客户都可以处理XML请求就移除这些代码”).

——引用自Python风格规范 — Google 开源项目风格指南

在 PyCharm 中，使用Alt + 6快捷键，可快速调出项目中的全部 TODO 注释。事实上，其中还包括 FIXME 注释，它表示需要修复的 BUG，优先级比较高

详情参见 Working with TODO in PyCharm ｜ PyCharm Blog

链接

下面总结了本文中使用的所有链接：

TODO 注释

链接

目录