Quiero agregar un comentario TODO de varias líneas a mi proyecto 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.
Desafortunadamente, PyCharm solo reconoce la primera línea como un comentario TODO. Las siguientes líneas se ven como comentarios estándar de Python.
¿Cuál es la forma correcta de formatear un comentario TODO de varias líneas en PyCharm?
Pycharm 2018.3 admite tareas multilínea, ¡sí!
https://youtu.be/5gJ7_3wCfUk?t=65
https://blog.jetbrains.com/pycharm/2018/11/pycharm-2018-3-out-now/
Entonces, usando tu comentario 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.
rendimientos:
En realidad, solo necesita sangrar las siguientes líneas un carácter a la derecha de TODO
, por lo que estaría al límite de ser detectado:
Y el todo se captura como un solo elemento, por supuesto:
Actualización: parece que JetBrains agregó esta función, vea la respuesta de payala
PyCharm no admite TODO de varias líneas, una opción alternativa sería usar una cadena de varias líneas
''' TODO foobar foobar '''
Esto no tendrá el resaltado TODO como # TODO foo
, pero se destacará del resto de su código con el resaltado de cadenas.
También podrías intentar
# TODO ----------------- # TODO foobar this # TODO comment # TODO comment # TODO comment # TODO ------------------
Si tiene una nota TODO particularmente gruesa e importante.