Como fazer comentários no Python | Aprenda Python

Por Pythoneiro

Compartilhe:

Nessa lição você vai aprender algo muito importante para qualquer programador, mas muitas vezes, negligenciado: o ato de comentar seus códigos.

Comentar código. é essencial para organização dos seus programas e scripts, tanto para você, quanto para o trabalho em equipe com outros profissionais que podem precisar dos seus códigos.

Comentar envolve colocar descrições legíveis por humanos dentro de programas de computador detalhando o que ocódigo está fazendo. Esses comentários não irão afetar a lógica, os cálculos e algoritmos do seu programa. Apenas servem de guia para o você do futuro ou outro alguém entender com mais clareza o que cada linha ou parte do cógido deve (ou deveria) fazer.

O uso adequado de comentários pode tornar a manutenção do código muito mais fácil, além de ajudar a encontrar bugs mais rapidamente. Além disso, comentar é muito importante ao escrever funções que outras pessoas usarão.

Como comentar códigos no python?

Cada linguagem de programação possui uma forma de comentar códigos. Dentro do Python, as comentários em Python são identificados com um símbolo de cerquilha # (ou hashtag, ou o nome que queria dar). Colocar esse símbolo na frente de uma linha, ou no meio dela, fará com que todo o resto da linha esteja comentado, ou seja, não irá rodar.

Existem três maneiras de escrever um comentário - como uma linha separada, ao lado da instrução de código correspondente ou como um bloco de comentário de várias linhas. Seja abaixo:

Comentário de uma linha separada

Se você rodar o código abaixo o resultado será 9.

# isso é uma soma 
print(4+5)

Veja como rodar esse código

O comentário "# isso é uma soma" será ignorado na hora que seu computador ler esse código. Mas explicou bem o que o código abaixo 4+5 faz. Perceba que apresentam cores diferentes. A maioria das IDEs (interfaces para desenvolvimento de códigos, como VSCode e Google Colab) apresnetam cores diferentes para facilitar nossa vida em identificar comentários, códigos, funções e tipos de dados.

Experimente rodar sem a #. Basta apagar a # do código. Note que indicará um erro, pois o comentário "isso é uma soma# não é reconhecido pela sua máquina.

Comentário ao lado

print(4+5) # isso é uma soma

Veja como rodar esse código

Novamente o mesmo comentário, mas agora ao lado. Perceba que o comentário só começa após a #.

Mútiplas linhas de comentário

Você precisa escrever uma descrição mais comprida do seu código e não quer colocar tudo em uma linha? Tudo bem, aqui explico como fazer comentários multilinhas no Python.

Opção 1: Usar # em cada linha

Exemplo:

 # Essa é a primeira linha de comentário 
# essa é a segunda 
# e a terceira

Opção 2: Usar 3 aspas duplas " para abrir e fechar comentário.

Isso é uma gambiarra aceitável. Na verdade isso não é um comentário teoricamente, mas sim uma string multilinhas.

Xiii, falou string, que raios é isso?Calma, nós vamos chegar lá em outro tutorial, mas basicamente, strings são tipos de dados que combinam diversos caracteres (letras, números e símbolo). Por exemplo, strings podem ser textos, nomes de pessoas, ruas, emails, animais, instrumentos, etc. Esse tipo de variável sempre vem dentro de aspas duplas. Para multlinhas, 3 aspas duplas.

Você pode usar desse recurso com aspas duplas para fazer comentários multilinhas no python. Veja:

  
""" 
Essa é a primeira linha de comentário 
essa é a segunda 
e a terceira 
"""

Falando em strings , caracteres de cerquilha (#) em uma string não são considerados comentários. Por exemplo, eu quero colocar a seguinte frase "procure a #pythoneiro no instagram" dentro de um variável chamada frase, ficaria assim:

Rode e perceba que nesse caso a cerquila # não serviu como comentário, pois está dentro de uma variável do tipo string chamada frase.

Essa coisa de dados e variáveis está confusa. Basta seguir a trilha toda que isso tudo vai ficar fácil no final 😉

Usando comentários para debugar

Por fim, você pode comentar linhas de códigos para evitar que elas sejam interpretadas pelo computador. Isso é especialmente útil quando precisar debugar, isto é, achar problemas (bugs) no seu código e algoritmo. Comentar parte dos código, um de cada vez, te ajudará a achar onde o possível bug está.

Exemplo:

# print("essa linha não será interpretada") print("essa linha será interpretada e isso será impresso na tela")

Resumo

Esse foi um tutorial sobre comentários em códigos no python. Daqui para frente, as próximas lições e tutoriais já sabe que linhsa que comecem com # são comentários e não serão interpretadas pelo computador.

Comentários no Python servem para explicar o código e algoritmo de forma geral ou linha por linha, trecho por trecho.
Comentários podem ser usados para tornar o código mais legível para você e para outros programadores, desenvolvedores e cientistas de dados.
Os comentários podem ser usados para impedir a execução ao testar o código. Comentar códigos é uma ferramenta muito útil para encontrar problemas e bugs em um programa, ou seja, debugar.
Comentários no Python começam com cerquila (#), por linha. Comentário multilinhas no Python podem ser feitos entre 3 aspas duplas.

Função print(): Hello Pythoneiro!

Lição Anterior

Valores e Variáveis no Python

Próxima Lição

Trilha de Aprendizado