How Do I Format a Multi-Line Todo Comment in Pycharm?
I Want to Add a Multi-Line Todo Comment to My Pycharm Project. # Todo: Multiple Errors Can Be Wrapped Inside an Exception. # Wfcapiexception Should Do...
I want to add a multi-line TODO comment to my PyCharm project.
# 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.
Unfortunately, PyCharm only recognizes the first line as a TODO comment. Any following lines are viewed as standard Python comments.
What is the correct way to format a multi-line TODO comment in PyCharm?
2 Answers
Pycharm 2018.3 does support multiline todo, yay!
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 foobar
foobar
'''
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.
Alexander Ross has covered the video game industry for a decade, writing deep dives on game design, esports tournaments, VR developments, and gaming culture.
