Comentários Inline
Lição 7 de 28 do curso Clean Code - Escreva códigos melhores com Python da Coddy.
Comentários em linha explicam uma única instrução em um trecho de código.
- Escreva comentários em linha na mesma linha que a instrução à qual eles se referem.
- Separe os comentários em linha por dois ou mais espaços da instrução.
- Começa com um
#e um único espaço. - Não os use para explicar o óbvio.
Por exemplo,
result = check(name) # Verifique se o nome é bomNa maioria das vezes, você preferirá usar Blocos de Comentários em vez de Blocos em Linha.
Desafio
FácilVocê recebeu um pequeno código que faz um pequeno cálculo para aumentar o salary, escreva um comentário inline que explique esta linha.
Esta é provavelmente uma explicação óbvia, mas para fins de prática, nós a faremos...
Experimente você mesmo
salary = 1000
salary = salary * 1.05