Regras de Código Limpo para Geração de Código por IA
ReferênciaPro4 minatualizado 2026-10-21
Estas regras orientam a geração de código para produzir código de fácil manutenção e de qualidade profissional.
Nomes Significativos
- Use nomes que revelem a intenção e expliquem por que razão algo existe
- Evite desinformação e distinções sem significado (por exemplo,
data,info,manager) - Use nomes pronunciáveis e pesquisáveis
- Nomes de classes: substantivos (por exemplo,
UserAccount,PaymentProcessor) - Nomes de métodos: verbos (por exemplo,
calculateTotal,sendEmail) - Evite o mapeamento mental e as codificações (notação húngara, prefixos)
Funções
- Mantenha as funções pequenas (< 20 linhas é o ideal)
- Faça apenas uma coisa - Princípio da Responsabilidade Única
- Um nível de abstração por função
- Limite os argumentos: 0-2 é o ideal, 3 no máximo, evite argumentos de sinalização
- Sem efeitos secundários - a função deve fazer o que o nome indica
- Separe os comandos (alteram o estado) das consultas (devolvem informação)
- Prefira exceções a códigos de erro
Este guia continua no plano Pro
Viu a introdução e o primeiro exemplo. Com o Pro desbloqueia este e todos os guias - atualizados todos os dias, com exemplos prontos a copiar.
Neste guia (Pro): Comentários · Formatação · Objetos e Estruturas de Dados · Tratamento de Erros · Classes · Testes Unitários · Princípios de Qualidade de Código · Code Smells a Evitar · Concorrência · Conceção de Sistemas · Refatorização · Documentação
7,99 €/mês · Sem fidelização · Cancele quando quiser
Componentes para esta tarefa
Escolhemos à mão os agentes, skills e comandos que resolvem este tipo de trabalho: Agentes e skills para revisão de código.
Guia da comunidade open-source (MIT) · tradução e manutenção Doutor AI.
Precisa de uma solução à medida?
Não sabe por onde começar a usar IA no seu negócio? Receba uma avaliação gratuita e um plano à medida - sem compromisso.
Poupe horas todas as semanas com IA, sem complicações
O Doutor AI dá-lhe 1859 prompts de IA prontos a copiar, por indústria e em português simples - mais uma biblioteca técnica completa para quem quer ir mais longe.