Как мне отформатировать многострочный комментарий TODO в PyCharm?

Question

Я хочу добавить многострочный комментарий TODO в мой проект PyCharm.

# 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.

Как правильно отформатировать многострочный комментарий TODO в PyCharm?

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

PyCharm не поддерживает многострочные TODO, одним из альтернативных вариантов будет использование многострочной строки

'''
TODO foobar
foobar
'''

Это не будет иметь подсветку TODO, как # TODO foo, но он будет выделяться из остальной части вашего кода с подсветкой строки.

Вы также можете попробовать

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

Если у вас есть особенно короткое и важное примечание TODO.