如何在 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

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

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

'''
TODO foobar
foobar
'''

这不会像 # TODO foo 那样突出显示 TODO，但它会通过字符串突出显示从其余代码中脱颖而出。

你也可以试试

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

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

Answer 2

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 右侧的一个字符，这样就不会被检测到：

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

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

How do I format a multi-line TODO comment in PyCharm?

python

comments

multiline

todo

pycharm