如何在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的右侧缩进以下几行，这样就可以检测到以下限制：

当然，待办事项被捕获为单个项目：

Answer 2

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

PyCharm does not支持多行TODO，另一种选择是使用多行字符串

'''
TODO foobar
foobar
'''

这不会像# TODO foo一样突出显示TODO，但它会突出显示字符串突出显示的其余代码。

您也可以尝试

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

如果你有一个特别厚实而重要的TODO音符。