Cómo comentar un bloque de código en Python

¿Existe un mecanismo para comentar grandes bloques de código Python?

En este momento, las únicas formas que puedo ver de comentar un código es comenzar cada línea con un # o encerrar el código entre comillas triples: """ .

El problema con estos es que insertar # antes de cada línea es engorroso y """ hace que la cadena que quiero usar como comentario aparezca en la documentación generada.

Después de leer todos los comentarios, la respuesta parece ser “No”.

    Python no tiene tal mecanismo. Prepone un # a cada línea para bloquear el comentario. Para más información ver PEP 8 . La mayoría de los IDE de Python admiten un mecanismo para hacer los signos de locking con comentarios de libra automáticamente para usted. Por ejemplo, en IDLE en mi máquina, es Alt + 3 y Alt + 4 .

    No uses comillas triples; Como descubrió, esto es para cadenas de documentación, no para bloquear comentarios, aunque tiene un efecto similar. Si solo estás comentando las cosas temporalmente, esto está bien como medida temporal.

    La única cura que conozco para esto es un buen editor. Lo siento.

    Oculte las comillas triples en un contexto que no se confundirá con una cadena de documentos, por ejemplo:

     ''' ...statements... ''' and None 

    o:

     if False: ''' ...statements... ''' 

    La única manera de hacer esto sin comillas triples es agregar un:

     if False: 

    Y luego sangra todo tu código. Tenga en cuenta que el código todavía tendrá que tener la syntax adecuada.


    Muchos IDE de Python pueden agregar # para usted en cada línea seleccionada, y eliminarlos cuando se desactiva también. Del mismo modo, si usa vi o Emacs , puede crear una macro para hacer esto por usted para un bloque de código.

    Mx comment-region, en el modo Python de Emacs .

    En JetBrains PyCharm en Mac use Comando + / para comentar / descomentar el bloque de código seleccionado. En Windows, utilice CTRL + / .

    Al menos en VIM, puede seleccionar la primera columna de texto que desea insertar usando el modo Bloquear Visual ( CTRL+V en VIM sin Windows) y luego añadir un # antes de cada línea usando esta secuencia:

     I# 

    En el modo Block Visual, I muevo para insertar el modo con el cursor antes del bloque en su primera línea. El texto insertado se copia antes de cada línea en el bloque.

    En vi :

    • Ir a la parte superior del bloque y marcarlo con la letra a.
    • Ir al final del bloque y marcarlo con la letra b

    Entonces hazlo

     :'a,'bs!^!#! 
     comm=''' Junk, or working code that I need to comment. ''' 

    Puede reemplazar la comm por una variable de su elección que quizás sea más corta, fácil de tocar y sabe que no ocurre (y no lo hará) en sus progtwigs. Ejemplos: xxx , oo , null , nil .

    Sí, hay (dependiendo de su editor). En PyDev (y en Aptana Studio con PyDev):

    • Ctrl + 4 – comentario bloque seleccionado

    • Ctrl + 5 – descomprimir bloque seleccionado

    En Visual Studio utilizando las herramientas de Python para Visual Studio , los bloques pueden ser comentados por Ctrl + K , Ctrl + C y no comentados por Ctrl + K , Ctrl + U.

    En Eclipse + PyDev , los comentarios de bloque de Python son similares a los comentarios de bloque de Eclipse Java; seleccione las líneas que desea comentar y use Ctrl + / para comentar. Para descomentar un bloque comentado, haga lo mismo.

    Utilizo Notepad ++ en una máquina con Windows, selecciono su código, escriba CTRL-K . Para descomentarlo, seleccione el código y presione Ctrl + Shift + K.

    Por cierto, Notepad ++ funciona bien como editor de Python. Con autocompletado, plegado de código, resaltado de syntax y mucho más. ¡Y es gratis como en el habla y como en la cerveza!

    El único mecanismo para comentar el código de Python (entendido como código ignorado por el intérprete) es el # .

    Como usted dice, también puede usar literales de cadena , que no son ignorados por el intérprete, pero pueden ser completamente irrelevantes para la ejecución del progtwig.

    En Eclipse usando PyDev , puede seleccionar un bloque de código y presionar Ctrl + # .

    Otra solución basada en editor: texto “rectangularjs” en Emacs.

    Resalte el código que desea comentar, luego Cxrt #

    Para anular el comentario del código: resalte, luego presione Cxrk

    Yo uso esto todo el día, todos los días. (Asignado a teclas de acceso rápido, por supuesto).

    Esta y poderosa búsqueda / reemplazo de expresiones regulares es la razón por la que tolero las otras “excentricidades” de Emacs.

    En Eric4 hay una manera fácil: seleccione un bloque, escriba Ctrl + M para comentar todo el bloque o Ctrl + alt + M para eliminar el comentario.

    Las comillas triples están bien para mí. Puede usar ” ‘foo’ ” para las cadenas de documentación y “” “barra” “” para comentarios o viceversa para que el código sea más legible.

    Use un editor agradable como SciTe , seleccione su código, presione Ctrl + Q y listo.

    Si no tiene un editor que admita comentarios de bloque, puede usar una cadena entre comillas al principio y al final de su bloque de código para comentarlo “efectivamente”. Sin embargo, no es la mejor práctica.