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

Rebeca Albuquerque — Thu, 26 Oct 2023 19:59:52 +0000

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;

Simplificando Orientação a Objetos

Rebeca Albuquerque — Fri, 15 Sep 2023 21:24:23 +0000

Objetos
Uma forma de entender a programação orientada a objetos (POO) é pensar em uma caixa de Lego gigante, onde cada peça é um objeto. Os objetos têm propriedades (cor, tamanho, forma) e podem fazer coisas específicas. Com POO, você cria seus programas como se estivesse construindo um mundo de lego.

Classes e Objetos
Vamos pensar em objetos como coisas do mundo real que têm características e funções. Por exemplo, um carro é um objeto que tem cor, modelo, velocidade, etc. (características) e que pode acelerar, frear, ligar, etc. (funções). Para criar objetos em um programa, precisamos de uma estrutura que defina essas características e funções. Essa estrutura é chamada de classe.

Encapsulamento e Abstração
Uma forma de entender o encapsulamento é pensar em um micro-ondas. Você não precisa saber como ele aquece a comida, só precisa apertar os botões certos. O encapsulamento esconde os detalhes internos e mostra apenas o que é necessário. Já a abstração é como uma lista de compras: você não precisa saber de onde vem cada produto, só precisa pegá-los no mercado. A abstração simplifica as coisas e ignora o que é desnecessário.

Herança e Polimorfismo
Uma herança é pensar na relação entre pais e filhos. Por exemplo, você pode ter uma classe "Animal" que define características comuns a todos os animais, como "respirar". Depois, você pode ter classes "Cachorro" e "Gato" que herdam essas características da classe "Animal", mas também podem ter características próprias, como "latir" e "miar". O polimorfismo é a capacidade de objetos diferentes terem nomes de método iguais, mas com comportamentos diferentes, como diferentes tipos de cachorro reagindo ao comando "sentar".

Aplicação Prática
Agora sabendo o básico, você pode criar objetos, definir classes e usar conceitos como herança e polimorfismo para resolver problemas de forma mais fácil e estruturada. É como ter um superpoder para enfrentar os desafios da programação.

DEV Community: Rebeca Albuquerque

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

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

Tratamento de erros:

Faça testes:

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

Java - Comentários Significativos:

// Exemplo não limpo:

// Exemplo de código limpo:

JavaScript - Funções Pequenas e Focadas:

// Exemplo não limpo:

// Exemplo de código limpo:

Python - Nomes Descritivos Significativos:

// Exemplo não limpo:

//Exemplo de código limpo:

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

Simplificando Orientação a Objetos