Neste tutorial, aprenderemos a criar comentários em Python com a ajuda de exemplos.
Vídeo: comentários em Python
Os comentários são descrições que ajudam os programadores a entender melhor a intenção e a funcionalidade do programa.
Eles são completamente ignorados pelo interpretador Python.
Vantagens de usar comentários
Usar comentários em programas torna nosso código mais compreensível. Isso torna o programa mais legível, o que nos ajuda a lembrar por que certos blocos de código foram escritos.
Além disso, os comentários também podem ser usados para ignorar algum código ao testar outros blocos de código. Isso oferece uma maneira simples de impedir a execução de algumas linhas ou de escrever um pseudocódigo rápido para o programa.
Comentários de linha única em Python
Em Python, usamos o símbolo hash #para escrever um comentário de uma única linha.
Exemplo 1: Escrevendo comentários de uma única linha
# printing a string print('Hello world')
Resultado
Olá Mundo
Aqui, o comentário é:
# printing a string
Esta linha é ignorada pelo interpretador Python.
Tudo o que vem depois #é ignorado. Portanto, também podemos escrever o programa acima em uma única linha como:
print('Hello world') #printing a string
A saída deste programa será a mesma do Exemplo 1 . O intérprete ignora todo o texto posterior #.
Comentários de várias linhas em Python
Python não oferece uma maneira separada de escrever comentários em várias linhas. No entanto, existem outras maneiras de contornar esse problema.
Podemos usar #no início de cada linha de comentário em várias linhas.
Exemplo 2: usando vários #
# it is a # multiline # comment
Aqui, cada linha é tratada como um único comentário e todos eles são ignorados.
Literais de string para comentários de várias linhas
Embora não haja uma maneira única de escrever comentários de várias linhas em Python, sabemos que o interpretador Python ignora os literais de string que não são atribuídos a uma variável.
Portanto, podemos até escrever um comentário de uma única linha como:
#this is a comment 'this is an unassigned string as a comment '
Aqui, podemos ver que a segunda linha do programa é uma string, mas não está atribuída a nenhuma variável ou função. Portanto, o interpretador ignora a string.
De maneira semelhante, podemos usar strings de várias linhas (aspas triplas) para escrever comentários de várias linhas.
O caractere de citação pode ser 'ou ".
Exemplo 3: usando literais de string para escrever comentários de várias linhas
''' I am a multiline comment! ''' print("Hello World")
Aqui, a string multilinha não é atribuída a nenhuma variável, por isso é ignorada pelo interpretador. Mesmo que não seja tecnicamente um comentário de várias linhas, ele pode ser usado como um.
Docstrings Python
Por convenção, as aspas triplas que aparecem logo após a função, método ou definição de classe são docstrings (strings de documentação).
Docstrings são associados a objetos e podem ser acessados usando o __doc__atributo.
Para saber mais, visite docstrings do Python.
Como escrever comentários melhores?
- Use comentários para descrever o que uma função faz e não os detalhes específicos sobre como a função o faz.
- Tente remover o máximo possível de comentários redundantes. Tente escrever um código que possa se explicar, usando uma melhor escolha de nome de função / variável.
- Tente fazer os comentários o mais curtos e concisos possível.
