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.”
- The Zen of Python
Os comentários são importantes para que qualquer pessoa que leia seu código possa entendê-lo.
Os comentários em Python se dividem em 3 tipos:
- Comentários de bloco
- Comentários em linha
- Strings de documentação
Vamos começar pelos Comentários de bloco -
- Começam no mesmo nível de indentação do bloco de código que descrevem.
- Comece cada linha com um
#seguido por um único espaço.
Por exemplo,
while i < 10:
# Loop sobre i até i < 10
# imprime i com nova linha e incrementa 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 essa função faz — com suas próprias palavras.
Siga as regras!
Experimente você mesmo
def greet(name):
print('Hello', name)Todas as lições de Clean Code - Escreva códigos melhores com Python
Pratique por conta própria: Compilador de Python online