Comment formater un commentaire TODO sur plusieurs lignes dans PyCharm?
Je veux ajouter un commentaire TODO sur plusieurs lignes à mon projet 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.
Malheureusement, PyCharm reconnaît uniquement la première ligne comme un commentaire TODO. Les lignes suivantes sont considérées comme des commentaires standard Python.
Quelle est la bonne façon de formater un commentaire TODO sur plusieurs lignes dans PyCharm?
Pycharm 2018.3 prend en charge les tâches multilignes, yay!
https://youtu.be/5gJ7_3wCfUk?t=65
https://blog.jetbrains.com/pycharm/2018/11/pycharm-2018-3-out-now/
Donc, en utilisant votre commentaire 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.
rendements:
En fait, il suffit de mettre en retrait les lignes suivantes d'un caractère à droite de TODO afin que ce soit juste à la limite d'être détecté:
Et la tâche est capturée comme un seul élément, bien sûr:
Mise à jour: Il semble que JetBrains ait ajouté cette fonctionnalité, voir la réponse de payala
PyCharm ne le fait pas supporte les TODO multi-lignes, une option alternative serait d'utiliser une chaîne multi-lignes
'''
TODO foobar
foobar
'''
Cela n'aura pas la surbrillance TODO comme # TODO foo, mais il se démarquera du reste de votre code avec la mise en évidence de la chaîne.
Vous pouvez également essayer
# TODO -----------------
# TODO foobar this
# TODO comment
# TODO comment
# TODO comment
# TODO ------------------
Si vous avez une note TODO particulièrement volumineuse et importante.