• Home
  • Jobs
  • Courses
  • Questions
  • Teachers
  • For business
  • ES/EN

0

127
Views
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 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.

Failed attempt at a multi-line TODO statement in PyCharm

What is the correct way to format a multi-line TODO comment in PyCharm?

4 months ago ·

Santiago Trujillo

2 answers
Answer question

0

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:

enter image description here

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:

enter image description here

And the todo is captured as a single item, of course:

enter image description here

4 months ago · Santiago Trujillo Report

0

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.

4 months ago · Santiago Trujillo Report
Answer question
Find remote jobs
Loading

Discover the new way to find a job!

Top jobs
Top job categories
Business
Post job Plans Our process Sales
Legal
Terms and conditions Privacy policy
© 2022 PeakU Inc. All Rights Reserved.