Comentários em Python 3

Os comentários em python são linhas de código que não são executadas e servem para escrever comentários e instruções no código. É comum que ao escrever um código nós criemos variáveis, funções e loops nós escrevamos pequenos comentários de instruções e explicações sobre o que se refere aquele bloco de código.

O que significa comentários em Python?

Os comentários em Python são linhas de texto que o interpretador do Python ignora quando executa o código. Eles são utilizados para documentar o código e fornecer informações adicionais sobre o que cada parte do código está fazendo.

Comentar o código em Python significa adicionar linhas de texto que o interpretador do Python irá ignorar quando executar o código. Essas linhas de texto são chamadas de comentários e são utilizadas para documentar o código e fornecer informações adicionais sobre o que cada parte do código está fazendo.

Os comentários são importantes para ajudar os outros desenvolvedores a entender o que está acontecendo no código e para ajudar você mesmo a se lembrar do que você fez no futuro. Comentar o código também é uma boa prática para tornar o código mais legível e fácil de manter.

Veja aqui nesse post que escrevi ensinando a usar o CNES no Python, a quantidade de comentários no python que fiz. Ao longo de todo o código eu deixei comentários para auxiliar o leitor e facilitar a compreensão do código.

Para que servem os comentários em python?

Os comentários servem para dois propósitos: comentar e instruir. Um comentário deve conter todas as informações necessárias para que outra pessoa consiga entender o que você fez naquele bloco de código.

Um código bem escrito além de funcionar, deve estar bem documentado. Lembre-se além de você outras pessoas também vão ler e utilizar o seu código. É fundamental que você deixe todos os comentários ao longo do seu código para que evite retrabalhos.

Os comentários são anotações que fazemos em nosso código e que não são executados. Comentar seu código faz parte das boas práticas em Python, pois facilita outros usuários a lerem e a entenderem melhor o seu código. Comentar um código é muito útil, sobretudo quando estamos começando, pois a partir das aulas e dos exercícios que você vai desenvolver, é possível ir descrevendo o que está sendo feito.

Não pense que o código por si só, é suficiente para outra pessoa conseguir entender o seu trabalho. Muitas vezes o próprio programador não sabe o que fez e o porque fez aquilo.

Quando devo utilizar os comentários no python?

Sempre! Os comentários não são caprichos opcionais. Comentários servem para outras pessoas e para você mesmo(a). Não deixe para depois, pois provavelmente você esquecerá o que fez e o porque fez daquela forma.

Como comentar um código em python?

Para comentar uma linha de código em python você deve utilizar o sinal de cerquilha (ou jogo da velha) em (#) e depois escrever o texto. Veja um exemplo:

# Comentário acima do código
print('Aprendendo Python no Balaio Científico')

Veja agora um comentário presente na frente do código:

print('Comentário no código') # Comentário na frente do código

Observe que facilita muito a compreensão do que estamos fazendo. Ao descrever os códigos, fica mais fácil para você e outro leitor(a) do código interpretar o que você fez. Existem outras formas de se comentar um código, podendo fazê-lo na frente da linha digitada, ou usando três aspas simples (”’) ou três aspas duplas (“””) para comentários que ultrapassam mais de uma linha. Veja a seguir:

soma = 5+5 # Criando uma variável de soma

'''
A partir do momento que coloquei três aspas simples, tudo o que eu escrever aqui dentro será considerado comentário.
É muito útil quando queremos explicar alguma coisa, ou deixar instruções dentro ou antes do código.
'''

"""
O mesmo ocorre com as aspas duplas.
Você pode escolher o que você quer usar.
A comunidade Python recomenda usar as aspas simples, mas fica a seu critério escolher.
"""

É importante notar que os comentários são apenas para uso do programador e não afetam o funcionamento do código. É uma boa prática incluir comentários no código para ajudar outros desenvolvedores a entender o que está acontecendo e para ajudar você mesmo a se lembrar do que você fez no futuro.

Viu como é simples deixar um comentário!?!? A partir de agora você pode começar a comentar todos os seus códigos e todos os exercícios de python que você está aprendendo. Sobretudo agora que você está dando os primeiros passos no python, comentar tudo vai te ajudar a fixar melhor o aprendizado.