How do I format a multi-line TODO comment in PyCharm?
Pycharm 2018.3 does support multiline todo, yay!
https://youtu.be/5gJ7_3wCfUk?t=65
https://blog.jetbrains.com/pycharm/2018/11/pycharm-2018-3-out-now/
So, using your TODO comment:
# 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.yields:
Actually, you only need to indent the following lines one character to the right of the TODO so this would be just on the limit from being detected:
And the todo is captured as a single item, of course:
Update: It appears JetBrains added this feature, see payala's answer
PyCharm does not support multi-line TODOs, one alternative option would be to use a multi line string
'''TODO foobarfoobar'''This won't have the TODO highlighting like # TODO foo, but it will stand out from the rest of your code with the string highlighting.
You could also try
# TODO -----------------# TODO foobar this# TODO comment # TODO comment# TODO comment# TODO ------------------If you have a particularly chunky and important TODO note.