Quais são as boas práticas do Código Limpo?

Neste artigo, vamos explorar o conceito e demais princípios que estão relacionados a ele. Existe algumas formas simples e algumas boas práticas para a realização correta do Clean Code, ou Código Limpo, como conhecemos.

Boa nomenclatura - escolha bons nomes para o seu código:

Os nomes são muito importantes para facilitar a comunicação e a compreensão do projeto ou software. Eles devem ser simples e diretos, sem ambiguidades ou confusões. Isso vale para qualquer elemento do código, como variáveis, funções, parâmetros, classes ou métodos.

Tratamento de erros:

Estamos acostumados a erros no processo. Mas, precisamos garantir que o software continue funcionando, mesmo diante de contratempos. Portanto, a gestão de erros é essencial e deve informar o usuário de forma simples. Assim, o software se mantém funcionando e o usuário entende o que ocorreu de errado.

Faça testes:

Testar o software é tão importante quanto tratar os erros, pois garante que o projeto funcione bem e atenda aos requisitos. Eu diria que é essencial, pois sem testes não dá para saber se o software está fazendo o que deveria ou não.

Aqui estão três exemplos de princípios de Código Limpo.

Java - Comentários Significativos:

Comentários bem colocados explicam a finalidade e o contexto do código, tornando-o mais claro para outros desenvolvedores que podem precisar trabalhar nele no futuro.

// Exemplo não limpo:

int resultado = calcular(idade, salario, true);

// Exemplo de código limpo:

// Calcula o bônus com base na idade e no salário, aplicando o ajuste para novos funcionários.

int bonus = calcularBonus(idade, salario, true);

JavaScript - Funções Pequenas e Focadas:

Dividir uma função grande e complexa em funções menores, cada uma com uma única responsabilidade, torna o código mais fácil de entender e de manter.

// Exemplo não limpo:

function processarPedido(pedido) {

// Lógica complexa de processamento de pedido

// ...

}

// Exemplo de código limpo:

function validarPedido(pedido) {

// Lógica de validação do pedido

// ...

}

function calcularTotal(pedido) {

// Lógica de cálculo do total

// ...

}

Python - Nomes Descritivos Significativos:

No exemplo de código limpo, as variáveis e funções têm nomes descritivos que indicam claramente o que estão fazendo, tornando o código mais legível.

// Exemplo não limpo:

def f():

x = 5

y = 10

return x + y

//Exemplo de código limpo:

def calcular_soma():

valor1 = 5

valor2 = 10

return valor1 + valor2

5 livros sobre Código Limpo, ou Clean Code:

• Clean Code - A Habilidade Essencial para o Desenvolvedor Moderno, do autor Robert C. Martin;

• Clean Architecture: Um Guia Prático para Desenvolvedores e Designers, do autor Robert C. Martin;

• O Programador Pragmático: Sua Jornada para se Tornar um Excelente Desenvolvedor, dos autores Andrew Hunt e Dave Thomas;

• Refatoração: Aperfeiçoando o Design de Código, do autor Martin Fowler;

• Projeto Limpo: Best Practices, do autor Robert C. Martin;