web-dev-qa-db-ja.com

PyCharmで複数行のTODOコメントをフォーマットするにはどうすればよいですか？

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コメントとして表示されます。

Failed attempt at a multi-line TODO statement in PyCharm

PyCharmで複数行のTODOコメントをフォーマットする正しい方法は何ですか？

pythonpycharmcommentsmultilinetodo
11
Stevoisiak

Pycharm 2018.3は、複数行のtodoをサポートしています。

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.

収量：

enter image description here

実際には、次の行をTODOの1文字右にインデントするだけでよいので、これは検出されないように制限されます。

enter image description here

もちろん、todoは単一のアイテムとしてキャプチャされます。

enter image description here

20
payala

更新：JetBrainsがこの機能を追加したようです、payalaの答えを参照してください

PyCharm しない 複数行のTODOをサポート、1つの代替オプションは複数行の文字列を使用することです

'''
TODO foobar
foobar
'''

これには、# TODO fooのようなTODO強調表示はありませんが、文字列強調表示により、コードの残りの部分から目立ちます。

また試すことができます

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

特に分厚い重要なTODOメモがある場合。

5
bphi