Comentários
Enviado: 03 Dez 2024, 04:54
Bem-vindo à seção cinco, na qual compartilharemos alguns comentários sobre comentários. Você aprenderá aqui por que é importante documentar seu código e por que você deve deixar comentários. Você também aprenderá como fazer isso e quando os comentários forem considerados uma boa prática. Vamos lá!
Comentários - por que, quando e como?
Você pode querer colocar algumas palavras dirigidas não ao Python, mas aos humanos, geralmente para explicar a outros leitores do código como funcionam os truques usados no código ou o significado das variáveis e, eventualmente, para manter armazenado informações sobre quem é o autor e quando o programa foi escrito.
Uma observação inserida no programa, que é omitida em tempo de execução, é chamada de comentário.
Como você deixa esse tipo de comentário no código-fonte? Ela precisa ser feita de forma que não force o Python a interpretá-la como parte do código.
Sempre que o Python encontra um comentário em seu programa, o comentário é completamente transparente para ele ‒ do ponto de vista do Python, esse é apenas um espaço (independentemente do tamanho do comentário real).
Em Python, um comentário é um pedaço de texto que começa com um sinal # (hash) e se estende até o final da linha.
Se você deseja um comentário que se estenda por várias linhas, deve colocar um hash na frente de todas elas. Assim como aqui:
Desenvolvedores bons e responsáveis descrevem cada parte importante do código, por exemplo, explicando o papel das variáveis. Embora deva ser declarado que a melhor maneira de comentar variáveis é nomeá-las de maneira inequívoca.
Por exemplo, se uma variável específica for projetada para armazenar uma área de algum quadrado único, o nomesquare_area será obviamente melhor do que aunt_jane.
Dizemos que o primeiro nome está auto comentado.
Comentários - por que, quando e como?
Você pode querer colocar algumas palavras dirigidas não ao Python, mas aos humanos, geralmente para explicar a outros leitores do código como funcionam os truques usados no código ou o significado das variáveis e, eventualmente, para manter armazenado informações sobre quem é o autor e quando o programa foi escrito.
Uma observação inserida no programa, que é omitida em tempo de execução, é chamada de comentário.
Como você deixa esse tipo de comentário no código-fonte? Ela precisa ser feita de forma que não force o Python a interpretá-la como parte do código.
Sempre que o Python encontra um comentário em seu programa, o comentário é completamente transparente para ele ‒ do ponto de vista do Python, esse é apenas um espaço (independentemente do tamanho do comentário real).
Em Python, um comentário é um pedaço de texto que começa com um sinal # (hash) e se estende até o final da linha.
Se você deseja um comentário que se estenda por várias linhas, deve colocar um hash na frente de todas elas. Assim como aqui:
Código: Selecionar todos
# Esse programa calcula a hipotenusa c.
# a e b são os tamanhos dos lados.
a = 3.0
b = 4.0
c = (a ** 2 + b ** 2) ** 0.5 # Nós usamos ** ao invés de raiz quadrada.
print("c =", c)Por exemplo, se uma variável específica for projetada para armazenar uma área de algum quadrado único, o nomesquare_area será obviamente melhor do que aunt_jane.
Dizemos que o primeiro nome está auto comentado.