Boas Práticas de desenvolvimento Seguindo o Livro Clean Code.

[leandro silva]

Um código mal escrito pode se transformar em um pesadelo para os desenvolvedores que precisam mantê-lo e entender sua lógica. É neste contexto que o livro “Clean Code: A Handbook of Agile Software Craftsmanship” de Robert Cecil Martin, amplamente conhecido como Uncle Bob, se destaca como uma obra fundamental para qualquer programador que deseje aprimorar suas habilidades de codificação.

Uncle Bob argumenta que o código limpo não é apenas uma questão de preferência pessoal, na verdade, é uma necessidade para qualquer projeto de software  que pretenda ter sucesso a longo prazo. Vamos explorar algumas das principais ideias apresentadas no livro, através de exemplos concretos, para entender como elas podem ser aplicadas na prática.

1. Significado Preciso através de Nomenclatura Clara:

Em um código limpo, os nomes das variáveis, funções e classes devem ser significativos e refletir com precisão o propósito que representam. Por exemplo, considere o seguinte trecho de código:

 

function calcular_area ® {
	a = 3.14 * r * r
	return a
};

Neste caso, as variáveis R e A não fornecem informações claras sobre seu significado. Em vez disso, podemos melhorar o código utilizando nomes mais descritivos:

 

function calcular_area_do_circulo(raio) {
	area = 3.14 * raio * raio
	return area
};

Agora, é evidente que a função "calcular_area_do_circulo” recebe um raio como parâmetro e retorna a área correspondente.

2. Funções devem fazer uma coisa:

O princípio da responsabilidade única afirma que cada função deve realizar apenas uma tarefa específica. Considere o seguinte exemplo:

 

class Funcionario_cozinheiro  {
	fazerPrato(prato) {
		//código para a realização de prato
	}

	valorDoPrato(prato) {
		// Código para o calculo do valor do prato
	}
	
	recolherPratos() {
		// Código para recolher os pratos
	}
}

Neste caso, a classe “Funcionario_cozinheiro” está realizando três tarefas distintas: fazendo o prato,calculando o preço do prato e recolhendo os pratos. Para tornar o código mais limpo e modular, podemos dividir essas tarefas em funções separadas:

 

class Cozinheiro {
	fazerPrato(prato) {
		// Código para a realização de pratos
	}
}

class Caixa {
	valorDoPrato(prato) {
		// Código paara o calculo do valor do prato
	}
}

class Garcon {
	recolherPratos() {
		// Código para recolher os pratos
	}
}

Dessa forma, cada função tem uma responsabilidade única e pode ser modificada independentemente das outras.

3. Evite Comentários Óbvios:

Comentários no código podem ser úteis, mas muitas vezes são usados como um subterfúgio para o código confuso. Em vez de adicionar comentários óbvios que explicam o que o código está fazendo, é melhor escrever o código de forma clara e autoexplicativa. Considere o seguinte exemplo:

// Verifica se o número é positivo ou negativo
if (numero > 0) {
	// Executa a lógica para números positivos
	// …
}

Neste caso, o comentário é redundante, pois a condição número > 0 já indica claramente que estamos verificando se o número é positivo. O código pode ser simplificado da seguinte forma:

if(numero > 0) {
	// Executa a lógica para números positivos
	// …
}

 

4. Formate o código de Maneira Consistente:

A formatação consistente do código é crucial para a legibilidade. Uncle Bob sugere adotar um estilo de formatação claro e consistente em todo o projeto. Por exemplo, decidir se as chaves das estruturas de controle (if, for, while) devem estar na mesma linha ou na próxima linha. Independentemente da escolha, é importante manter a consistência em todo o código. Aqui está um exemplo:
 

// Formato inconsistente

function primeiroExemplo() {
	if(condicao) 
    {
		// código
	}
	else
	{
		// código
	}
}

// Formato consistente

function segundoExemplo() {
	if(condicao) {
		// código
	} else 	{
		// código
	}
}

No primeiroExemplo, as chaves estão em linhas diferentes para if e else, tornando o código visualmente desigual. Já no segundoExemplo, o código segue um estilo consistente, facilitando a leitura e compreensão do código.

Conclusão:

O livro “Clean Code” é uma leitura essencial para todos os desenvolvedores que desejam elevar a qualidade de seus códigos. Ao adotar princípios como nomenclatura clara, funções com responsabilidade única, evitar comentários óbvios e formatação consistente, os programadores podem criar softwares mais robustos, fáceis de entender e de manter.