Squad Front

Appearance

Clean Code (Código Limpo) ​

Clean Code é um conjunto de práticas e princípios aplicados ao desenvolvimento de software que visam melhorar a legibilidade, facilidade de manutenção e compreensão do código. No nosso projeto, o código limpo é a base para a colaboração eficiente.

1. Nomes Significativos ​

O nome de uma variável, função ou classe deve revelar sua intenção.

✅ Como fazer ​

typescript
const diasParaExpirar = 30;
const pacientesAtivos = fetchActivePatients();

❌ Como não fazer ​

typescript
const d = 30;
const data = getList();

2. Funções Curtas e Focadas ​

Uma função deve fazer apenas uma coisa e fazê-la bem. Se uma função tem muitos "and", ela provavelmente faz coisas demais.

✅ Como fazer ​

typescript
function formatarMoeda(valor: number) {
  return new Intl.NumberFormat('pt-BR', { style: 'currency', currency: 'BRL' }).format(valor);
}

❌ Como não fazer ​

typescript
function processarDadosEGerarInterfaceERenderizar() {
  // 50 linhas de lógica misturada
}

3. Comentários: O Menos é Mais ​

Comentários devem ser usados apenas quando o código, por si só, não consegue explicar o porquê de uma decisão complexa. O código deve explicar o o que ele está fazendo através de bons nomes.

  • Bom: Explica uma regra de negócio bizarra ou um "hack" necessário para um navegador específico.
  • Ruim: Comenta o óbvio ou código que foi comentado em vez de deletado.

4. Tratamento de Erros ​

O tratamento de erros deve ser claro e não deve esconder falhas silenciosamente. No nosso projeto, usamos Classes de Erro para garantir que saibamos exatamente o que falhou.

5. Regra do Escoteiro ​

"Deixe o código sempre um pouco mais limpo do que você o encontrou."

Se você viu um nome de variável ruim em um arquivo que está editando, renomeie. Se viu uma função duplicada, tente unificar. Pequenas melhorias constantes evitam o acúmulo de dívida técnica.

Como fazer vs Como não fazer ​

✅ Como fazer ​

  • Use nomes que podem ser pronunciados e pesquisados.
  • Evite passar muitos argumentos para uma função (prefira um objeto de configuração).
  • Siga o Code Style do projeto para garantir consistência visual.

❌ Como não fazer ​

  • Deixar código "morto" (comentado) no repositório. Delete, o Git serve para recuperar o histórico.
  • Usar abreviações que só você entende (ex: c para component, idx para index).
  • Criar funções com efeitos colaterais escondidos (muda algo global sem o usuário saber).