Este documento estabelece as diretrizes para nomeação e tipagem de dados em nossos projetos, visando legibilidade e manutenção simplificada.
snake_case)O snake_case é o padrão de escrita onde todas as palavras são minúsculas e separadas por um sublinhado (_).
💡 Por que usar? É a recomendação oficial da PEP 8 para Python. O sublinhado funciona como um espaço visual, facilitando a leitura rápida.
.py files)Exemplo:
Python
# Correto
user_first_name = "Alice"
calculate_final_price()
# Incorreto
userFirstName = "Alice" # camelCase
CalculateFinalPrice() # PascalCase
Todo o código (variáveis, funções, classes e comentários técnicos) deve ser escrito em Inglês.
| De (Português) | Para (Inglês) | Por que? |
|---|---|---|
preco_total |
total_price |
Consistência com bibliotecas externas. |
usuario_logado |
is_logged_in |
Facilita a colaboração internacional. |
buscar_dados |
fetch_data |
Evita caracteres especiais (acentos/cedilha). |
O Type Hinting permite especificar o tipo de dado esperado para variáveis e retornos de função.