如何在PyCharm中格式化多行TODO注释？

Question

我想在我的PyCharm项目中添加多行TODO注释.

# TODO: Multiple errors can be wrapped inside an exception.
#       WfcApiException should do recursive error checking to locate
#       and store an arbitrary number of nested errors.

不幸的是,PyCharm只将第一行识别为TODO评论.以下任何行都被视为标准Python注释.

在PyCharm中格式化多行TODO注释的正确方法是什么？

Answer 1

Pycharm 2018.3确实支持多行待办事项,耶!

https://youtu.be/5gJ7_3wCfUk?t=65

https://blog.jetbrains.com/pycharm/2018/11/pycharm-2018-3-out-now/

所以,使用你的TODO评论:

# TODO: Multiple errors can be wrapped inside an exception.
#       WfcApiException should do recursive error checking to locate
#       and store an arbitrary number of nested errors.

收益率:

实际上,你只需要将下面的一行缩进到右边的一个字符,TODO这样就可以检测出来了:

并且todo被捕获为单个项目,当然:

Answer 2

更新:看来JetBrains添加了此功能,请参阅payala的回答

PyCharm 不支持多行TODO,另一种选择是使用多行字符串

'''
TODO foobar
foobar
'''

这将没有TODO突出显示# TODO foo,但它将突出显示字符串高亮显示其余代码.

你也可以试试

# TODO -----------------
# TODO  foobar this
# TODO  comment 
# TODO  comment
# TODO  comment
# TODO ------------------

如果你有一个特别厚实和重要的TODO笔记.