Comente um bloco de código em Python

Muhammad Maisam Abbas 30 janeiro 2023
  1. Adicione # antes de cada linha para comentar várias linhas em Python
  2. Use aspas triplas para comentários multilinha em Python
  3. Use if False: para comentários multilinha em Python
  4. Use uma variável de string para comentários multilinha em Python
  5. Use um editor de código para comentários multilinha em Python
Comente um bloco de código em Python

Neste tutorial, discutiremos métodos para comentar várias linhas de código em Python.

Adicione # antes de cada linha para comentar várias linhas em Python

O # é usado para comentários de uma linha em Python. Infelizmente, não existe um método padrão de comentar várias linhas de código em Python. Para comentar várias linhas de código usando o #, temos que adicionar um # antes de cada linha. O exemplo de código a seguir nos mostra como podemos usar # para comentar várias linhas de código em Python.

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

Resultado:

This is not a comment

No código acima, comentamos as primeiras 3 linhas de código usando # antes de cada linha. Essa abordagem é adequada para menos linhas, mas esse processo pode se tornar muito trabalhoso se tivermos um grande número de linhas.

Use aspas triplas para comentários multilinha em Python

As aspas triplas são usadas para documentação de código e não são executadas durante a execução do código. O exemplo de código a seguir nos mostra como usar aspas triplas para comentar várias linhas de código em Python.

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

Resultado:

This is not a comment

No código acima, comentamos as primeiras 3 linhas de código, colocando-as entre aspas triplas. As aspas triplas reduzem drasticamente o esforço. Mas, as aspas triplas são projetadas para serem usadas para documentação de código e não devem ser usadas para comentar o código.

Use if False: para comentários multilinha em Python

Outra abordagem que pode ser usada para comentar várias linhas de código em Python é a instrução if False:. Tudo o que está escrito neste bloco de código nunca é executado porque nunca é False neste contexto. Nós apenas temos que escrever if False: antes do bloco de código que queremos comentar e então indentar nosso código dentro da instrução if. O exemplo de código a seguir nos mostra como podemos usar if False: para comentar várias linhas de código em Python.

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

Resultado:

This is not a comment

No código acima, comentamos 2 linhas de código usando if False:. O único problema com essa abordagem é que ela só pode comentar um bloco de código com a sintaxe adequada. O interpretador ainda detectará erros de sintaxe neste bloco de código.

Use uma variável de string para comentários multilinha em Python

Uma variável de string pode ser usada para armazenar várias linhas de código nela. Podemos usar aspas triplas para armazenar várias linhas de código em uma variável de string. O exemplo de código a seguir nos mostra como podemos usar uma variável de string para comentar várias linhas de código em 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")

Resultado:

This is not a comment

A mesma variável pode ser usada várias vezes para comentar vários blocos de código em Python.

Use um editor de código para comentários multilinha em Python

Discutimos muitas abordagens que podem ser usadas para comentar várias linhas de código em Python. Mas, infelizmente, nenhuma das abordagens acima é uma solução ideal. A melhor solução para essa tarefa seria usar os atalhos de teclado do editor de código desejado para comentar várias linhas de código em Python.

Code Visual Studio

No código do Visual Studio, selecione o bloco de código e usar Ctrl+k>k, Ctrl+>kbd>c>/kbd> para comentar e Ctrl+kbd>k, Ctrl+>kbd>u>/kbd> para descomentar.

Notepad++

No Notepad++, selecione o bloco de código e usar Ctrl+k para comentar.

PyCharm

No Pycharm IDE, selecione o bloco de código e utilizar Ctrl+/kbd>/kbd> para comentar e descomentar.

Não importa qual editor de código você esteja usando, ele tem uma maneira de comentar várias linhas de código. Tudo o que você precisa fazer é pesquisar o atalho de teclado para comentar várias linhas.

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

Artigo relacionado - Python Syntax