Para quem quer sair do básico e começar a escrever código como profissional
Comentários existem para complementar o código, não para explicar cada linha. Um código bem escrito exige poucos comentários porque já é autoexplicativo.
Regra de ouro: comente o porquê, não o que.
Exemplo ruim:
python
CopiarEditar
x = x + 1 # incrementa x em 1
Exemplo bom:
python
CopiarEditar
# Atualiza a pontuação do usuário após uma ação correta
pontuacao += 1
São usados em funções, classes e módulos para descrever claramente seu comportamento. Use """ """ logo após a definição.
python
CopiarEditar
def calcular_area(base, altura):
"""
Calcula a área de um triângulo.
Parâmetros:
base (float): base do triângulo
altura (float): altura do triângulo
Retorna:
float: área do triângulo
"""
return (base * altura) / 2
Use sempre que quiser que a função possa ser reutilizada por outras pessoas (ou por você no futuro).