Comentar un bloque de código en Python

Muhammad Maisam Abbas 30 enero 2023
  1. Agregue # antes de cada línea para comentar varias líneas en Python
  2. Utilice comillas triples para comentarios de varias líneas en Python
  3. Utilice if False: para comentarios de varias líneas en Python
  4. Utilice una variable de cadena para comentarios de varias líneas en Python
  5. Utilice un editor de código para comentarios de varias líneas en Python
Comentar un bloque de código en Python

En este tutorial, discutiremos métodos para comentar varias líneas de código en Python.

Agregue # antes de cada línea para comentar varias líneas en Python

El # se utiliza para comentarios de una sola línea en Python. Desafortunadamente, no existe un método predeterminado para comentar varias líneas de código en Python. Para comentar varias líneas de código usando el #, tenemos que agregar un # antes de cada línea. El siguiente ejemplo de código nos muestra cómo podemos usar # para comentar varias líneas de código en Python.

# Hello! this is a
# Multiple line comment
# print("This is a comment")
print("This is not a comment")

Producción :

This is not a comment

En el código anterior, comentamos las primeras 3 líneas de código usando # antes de cada línea. Este enfoque está bien para menos líneas, pero este proceso puede volverse muy laborioso si tenemos una gran cantidad de líneas.

Utilice comillas triples para comentarios de varias líneas en Python

Las Comillas triples se utilizan para la documentación del código y no se ejecutan durante la ejecución del código. El siguiente ejemplo de código nos muestra cómo usar comillas triples para comentar varias líneas de código en Python.

"""
Hello! this is a 
Multiple line comment
print("This is a comment")
"""
print("This is not a comment")

Producción :

This is not a comment

En el código anterior, comentamos las primeras 3 líneas de código poniéndolas entre comillas triples. Las comillas triples reducen drásticamente el esfuerzo. Sin embargo, las comillas triples están diseñadas para usarse en la documentación del código y no deben usarse para comentar el código.

Utilice if False: para comentarios de varias líneas en Python

Otro enfoque que se puede utilizar para comentar varias líneas de código en Python es la declaración if False:. Todo lo escrito en este bloque de código nunca se ejecuta porque nunca es False en este contexto. Solo tenemos que escribir if False: antes del bloque de código que queremos comentar y luego sangrar nuestro código dentro de la declaración if. El siguiente ejemplo de código nos muestra cómo podemos usar if False: para comentar varias líneas de código en Python.

if False:
    print("This is a comment")
    print("This is another comment")
print("This is not a comment")

Producción :

This is not a comment

En el código anterior, comentamos 2 líneas de código usando if False:. El único problema con este enfoque es que solo puede comentar un bloque de código con la sintaxis adecuada. El intérprete seguirá detectando errores de sintaxis en este bloque de código.

Utilice una variable de cadena para comentarios de varias líneas en Python

Una variable de cadena se puede utilizar para almacenar varias líneas de código en ella. Podemos usar comillas triples para almacenar múltiples líneas de código en una variable de cadena. El siguiente ejemplo de código nos muestra cómo podemos usar una variable de cadena para comentar varias líneas de código en Python.

comments = "This is a variable for commenting"
comments = """Hello! this is a 
Multiple line comment
print("This is a comment")"""
print("This is not a comment")

Producción :

This is not a comment

La misma variable se puede utilizar varias veces para comentar varios bloques de código en Python.

Utilice un editor de código para comentarios de varias líneas en Python

Hemos discutido muchos enfoques que se pueden usar para comentar varias líneas de código en Python. Pero, desafortunadamente, ninguno de los enfoques anteriores es una solución óptima. La mejor solución para esta tarea sería utilizar los atajos de teclado del editor de código que desee para comentar varias líneas de código en Python.

Código de Visual Studio

En Visual Studio Code, seleccione el bloque de código y utiliza Ctrl+k, Ctrl+c para comentar y Ctrl+k, Ctrl+u para descomentar.

Notepad++

En Notepad++, seleccione el bloque de código y utiliza Ctrl+k para comentar.

PyCharm

En Pycharm IDE, seleccione el bloque de código y utiliza Ctrl+/ para comentar y descomentar.

Independientemente del editor de código que esté utilizando, tiene una forma de comentar varias líneas de código. Todo lo que tiene que hacer es buscar el atajo de teclado para comentar varias líneas.

Muhammad Maisam Abbas avatar Muhammad Maisam Abbas avatar

Maisam is a highly skilled and motivated Data Scientist. He has over 4 years of experience with Python programming language. He loves solving complex problems and sharing his results on the internet.

LinkedIn

Artículo relacionado - Python Syntax