Comentários de Bloco
Lição 6 de 28 do curso Clean Code - Escreva códigos melhores com Python da Coddy.
“Se a implementação é difícil de explicar, é uma má ideia.”
- O Zen do Python
Comentários são importantes para que qualquer pessoa que leia seu código possa entendê-lo.
Comentários em Python se dividem em 3 tipos:
- Comentários de Bloco
- Comentários em Linha
- Strings de Documentação (Docstrings)
Vamos começar pelos Comentários de Bloco -
- Começam no mesmo bloco de indentação que o código que descrevem.
- Comece cada linha com um
#seguido por um único espaço.
Por exemplo,
while i < 10:
# Faz um loop sobre i até que i < 10
# imprime i com uma nova linha e incrementa-o em 1
print(i, '\n')
i += 1
Desafio
FácilVocê recebeu a função greet; escreva um comentário de bloco para descrever o que esta função faz - com suas próprias palavras.
Siga as regras!
Experimente você mesmo
def greet(name):
print('Hello', name)