Declarações, Indentação e Comentários em Python: Guia Claro

Declarações, Indentação e Comentários em Python

Este guia explica declarações Python, a importância da indentação consistente e como usar comentários e docstrings efetivamente.

Declarações em Python

Instruções Python que o interpretador executa são chamadas declarações. Exemplos comuns incluem declarações de atribuição como a = 1, declarações de controle de fluxo como if, for e while. Esses fundamentos formam os blocos de construção de todo programa Python.

Declarações de múltiplas linhas

Por padrão, uma nova linha termina uma declaração. Para dividir uma declaração longa em várias linhas, use a barra invertida (\) como caractere de continuação de linha:

a = 1 + 2 + 3 + \ 4 + 5 + 6 + \ 7 + 8 + 9

De forma mais idiomática, Python permite continuação implícita dentro de parênteses, colchetes ou chaves:

a = (1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9)

Similarmente, literais de lista podem abranger múltiplas linhas:

cores = ['vermelho', 'azul', 'verde']

Você também pode colocar várias declarações simples em uma linha usando ponto e vírgula:

a = 1; b = 2; c = 3

---

Indentação em Python

Diferente de linguagens que usam chaves, Python define blocos de código puramente através de indentação. Um bloco começa após dois-pontos e termina na primeira linha que não está indentada relativa ao início do bloco.

Embora a linguagem permita qualquer nível de indentação consistente, o padrão da comunidade é quatro espaços. Tabs devem ser evitados para evitar confusão.

for i in range(1, 11): print(i) if i == 5: break

Indentação adequada não apenas impõe sintaxe, mas também torna o código imediatamente legível e mantenível. Por exemplo:

if True: print('Olá') a = 5

versus a forma menos legível em linha única:

if True: print('Olá'); a = 5

Indentação incorreta dispara IndentationError e interrompe a execução.

---

Comentários em Python

Comentários são vitais para documentar intenção e lógica, especialmente ao revisitar código meses depois. Em Python, um comentário começa com cerquilha (#) e se estende até o fim da linha. O interpretador ignora essas linhas completamente.

# Isto é um comentário # Imprime saudação print('Olá')

---

Comentários de múltiplas linhas

Para abranger múltiplas linhas, prefixe cada linha com #:

# Este é um comentário longo # que continua por várias # linhas

Alternativamente, strings entre aspas triplas podem servir como comentários de bloco. Quando não atribuídas ou usadas como docstring, são descartadas pelo interpretador, sem custo de runtime:

"""Este é um comentário de múltiplas linhas que abrange várias linhas."""

---

Docstrings em Python

Uma docstring é um literal de string que segue uma definição de função, classe ou módulo. Documenta o propósito do elemento e é armazenada em seu atributo __doc__. Aspas triplas são convencionalmente usadas:

def dobro(num): """Retorna o dobro do valor de entrada.""" return 2 * num

Você pode acessá-la programaticamente:

print(dobro.__doc__)

Saída:

Retorna o dobro do valor de entrada.

Para diretrizes mais detalhadas, consulte a documentação oficial do Python sobre comentários e docstrings.