Clean code

Quem sou eu. @marcosbrizeno brizeno.wordpress.com

Revele sua intenção double calcula( double d1, double d2); int main() { double prProd = 17.99; double desc = 0.2; double valor = calcula(prProd, desc); cout << valor; return 0; } double calcula( double d1, double d2) { return d1 - (d1 * d2); }

Revele sua intenção double calcula( double d1, double d2); int main() { // preço do produto double prProd = 17.99; // valor do desconto double desc = 0.2; // valor do produto com desconto double valor = calcula(prProd, desc); cout << valor; return 0; } // calcula o valor de um produto com desconto double calcula( double d1, double d2) { return d1 - (d1 * d2); }

Mapa Mental double calcula( double d1, double d2); int main() { // preço do produto double prProd = 17.99; // valor do desconto double desc = 0.2; // valor do produto com desconto double valor = calcula(prProd, desc); cout << valor; return 0; } // calcula o valor de um produto com desconto double calcula( double d1, double d2) { return d1 - (d1 * d2); }

Revele sua intenção int main() { // preço do produto double precoDoProduto = 17.99; // valor do desconto double desconto = 0.2; // valor do produto com desconto double valorComDesconto = calculaDesconto(precoDoProduto, desconto); cout << valor; return 0; } // calculo o valor de um produto com desconto double calculaDesconto( double d1, double d2) { return d1 - (d1 * d2); }

Revele sua intenção int main() { double precoDoProduto = 17.99; double desconto = 0.2; double valorComDesconto = calculaDesconto(precoDoProduto, desconto); cout << valor; return 0; } double calculaDesconto( double d1, double d2) { return d1 - (d1 * d2); }

Nomes Genéricos #Envia o boleto para ser descontado no banco def processa (boletoBancario): #Calcula o imposto total de um funcionário def calcula (funcionario): #Mostra o relatório de finanças def mostrar (): #Executa consultas na fila de espera def executar ():

Nomes Genéricos #Envia o boleto para ser descontado no banco def descontarBoleto (boletoBancario): #Calcula o imposto total de um funcionário def calcularImposto (funcionario): #Mostra o relatório de finanças def mostrarRelatorio (): #Executa consultas na fila de espera def executarConsultasEmEspera ():

Nomes Genéricos def descontarBoleto (boletoBancario): def calcularImposto (funcionario): def mostrarRelatorio (): def executarConsultasEmEspera ():

Diferencie diferenças private double calculaDesconto( double d1, double d2); private void copiar(String s1, String s2); private boolean maiorQue( int n1, int n2);

Diferencie diferenças private double calculaDesconto( double preco, double desconto); private void copiar(String fonte, String alvo); private boolean maiorQue( int referência, int numero);

Dê nomes a tudo! class Taxi { protected : int horaDaCorrida ; double quilometros ; public : double calcularValorCorrida() { if ( horaDaCorrida > 22 && horaDaCorrida < 5) { return quilometros * 3.7; } return quilometros * 2.9; } };

Dê nomes a tudo! #define PRECO_BANDEIRA_2 3.7 #define PRECO_BANDEIRA_1 2.9 class Taxi { protected : int horaDaCorrida ; double quilometros ; public : double calcularValorCorrida() { if ( horaDaCorrida > 22 && horaDaCorrida < 5) { return quilometros * PRECO_BANDEIRA_2; } return quilometros * PRECO_BANDEIRA_1; } };

Dê nomes a tudo! // opening and closing a file #include <iostream> #include <fstream> using namespace std; int main () { ofstream outfile; outfile.open( ".// tmp //test.txt" ); // >> i/o operations here << outfile.close(); return 0; } // opening and closing a file #include <iostream> #include <fstream> using namespace std; #define TMP_DIR ".// tmp //" int main () { ofstream outfile; string diretorio = TMP_DIR; diretorio.append( "test.txt" ); outfile.open(diretorio.c_str()); // >> i/o operations here << outfile.close(); return 0; }

Única responsabilidade public void venderProduto(Vendedor vendedor, Produto produto) { // Verifica se o produto tem desconto for (Produto produtosComDesconto : ProdutosComDesconto) { if (produtosComDesconto.getId() == produto.getId()) { // Calcula o valor com desconto double valorFinal = produto.getPreco() - produto.getPreco() * VALOR_DESCONTO ; // Cria o boleto de pagamento Boleto boletoDePagamento = new Boleto(); boletoDePagamento.setNomeVendedor(vendedor.getNome()); boletoDePagamento.setValor(valorFinal); boletoDePagamento.imprimir(); } } // Se o produto não tiver desconto // Cria o boleto de pagamento Boleto boletoDePagamento = new Boleto(); boletoDePagamento.setNomeVendedor(vendedor.getNome()); boletoDePagamento.setValor(produto.getValor()); boletoDePagamento.imprimir(); }

Única responsabilidade public void venderProduto(Vendedor vendedor, Produto produto) { // Verifica se o produto tem desconto for (Produto produtosComDesconto : ProdutosComDesconto) { if (produtosComDesconto.getId() == produto.getId()) { // Calcula o valor com desconto double valorFinal = produto.getPreco() - produto.getPreco() * VALOR_DESCONTO ; // Cria o boleto de pagamento criarBoletoDePagamento(vendedor.getNome(), valorFinal); } } // Se o produto não tiver desconto // Cria o boleto de pagamento criarBoletoDePagamento(vendedor.getNome(), produto.getPreco()); }

Única responsabilidade public void venderProduto(Vendedor vendedor, Produto produto) { // Verifica se o produto tem desconto if (produtoTemDesconto(produto)) { // Calcula o valor com desconto double valorFinal = produto.getPreco() - produto.getPreco() * VALOR_DESCONTO ; // Cria o boleto de pagamento criarBoletoDePagamento(vendedor.getNome(), valorFinal); } // Se o produto não tiver desconto // Cria o boleto de pagamento criarBoletoDePagamento(vendedor.getNome(), produto.getPreco()); }

Única responsabilidade public void venderProduto(Vendedor vendedor, Produto produto) { // Verifica se o produto tem desconto double valorFinal = produto.getPreco(); if (produtoTemDesconto(produto)) { // Calcula o valor com desconto // Cria o boleto de pagamento valorFinal = calcularDesconto(produto.getPreco()); } // Se o produto não tiver desconto // Cria o boleto de pagamento criarBoletoDePagamento(vendedor.getNome(), valorFinal); }

Única responsabilidade public void venderProduto(Vendedor vendedor, Produto produto) { double valorFinal = produto.getPreco(); if (produtoTemDesconto(produto)) valorFinal = calcularDesconto(produto.getPreco()); } criarBoletoDePagamento(vendedor.getNome(), valorFinal); }

Agrupar funções public void venderProduto( Vendedor vendedor, Produto produto) { double valorFinal = produto.getPreco(); if (produtoTemDesconto(produto)) { valorFinal = calcularDesconto(produto.getPreco()); } criarBoletoDePagamento(vendedor.getNome(), valorFinal); } public void criarBoletoDePagamento(String nomeVendedor, double valorProduto); public double calcularDesconto( double preco); public boolean produtoTemDesconto(Produto produto);

Estruturas de Decisão #define PRECO_BANDEIRA_2 3.7 #define PRECO_BANDEIRA_1 2.9 class Taxi { protected : int horaDaCorrida ; double quilometros ; private : bool ehHorarioNormal() { return horaDaCorrida < 22 && horaDaCorrida > 5; } public : double calcularValorCorrida() { if (!ehHorarioNormal()) { return quilometros * PRECO_BANDEIRA_2; } return quilometros * PRECO_BANDEIRA_1; } };

Estruturas de Decisão #define PRECO_BANDEIRA_2 3.7 #define PRECO_BANDEIRA_1 2.9 class Taxi { protected : int horaDaCorrida ; double quilometros ; private : bool ehHorarioNormal() { return horaDaCorrida < 22 && horaDaCorrida > 5; } public : double calcularValorCorrida() { if (ehHorarioNormal()) { return quilometros * PRECO_BANDEIRA_1; } return quilometros * PRECO_BANDEIRA_2; } };

Retornar nulo public double dividir( int dividendo, int divisor) { if (divisor == 0) { return -1; } return dividendo / divisor; }

Retornar nulo public double dividir( int dividendo, int divisor) { if (divisor == 0) { return -1; } return dividendo / divisor; } public double dividir( int dividendo, int divisor) throws Exception { if (divisor == 0) { throw new Exception( "Impossível dividir por zero" ); } return dividendo / divisor; }

Formatação public String getTabuleiro() { String string = "" ; for ( int i = 0; i < getAltura(); i++) { for ( int j = 0; j < getLargura(); j++) { string += tabuleiroEscondido [i][j];} if (i != tabuleiroEscondido . length - 1) { string += "\n" ; } } return string; }

Formatação public String getTabuleiro() { String string = "" ; for ( int i = 0; i < getAltura(); i++) { for ( int j = 0; j < getLargura(); j++) { string += tabuleiroEscondido [i][j]; } if (i != tabuleiroEscondido . length - 1) { string += "\n" ; } } return string; }

Repetição public void venderProduto(Vendedor vendedor, Produto produto) { // Verifica se o produto tem desconto for (Produto produtosComDesconto : ProdutosComDesconto) { if (produtosComDesconto.getId() == produto.getId()) { // Calcula o valor com desconto double valorFinal = produto.getPreco() - produto.getPreco() * VALOR_DESCONTO ; // Cria o boleto de pagamento Boleto boletoDePagamento = new Boleto(); boletoDePagamento.setNomeVendedor(vendedor.getNome()); boletoDePagamento.setValor(valorFinal); boletoDePagamento.imprimir(); } } // Se o produto não tiver desconto // Cria o boleto de pagamento Boleto boletoDePagamento = new Boleto(); boletoDePagamento.setNomeVendedor(vendedor.getNome()); boletoDePagamento.setValor(produto.getValor()); boletoDePagamento.imprimir(); }

Repetição public class Imagem { public void moverImagem( int x, int y){ this .imagem.getRetangulo().getPontoX().set(x); this .imagem.getRetangulo().getPontoY().set(y); } }

Repetição public class Imagem { public void moverImagem( int x, int y){ this .imagem.getRetangulo().getPontoX().set(x); this .imagem.getRetangulo().getPontoY().set(y); } } public class Imagem { public void moverImagem( int x, int y){ this .imagem.getRetangulo().mover(x, y); } }

Métodos longos = muita responsabilidade!

Muitos argumentos são sintomas de muitas responsabilidades!

Argumento booleano grita que a função faz mais de uma coisa!

Sentiu vontade de comentar? Refatore e depois comente!

Se vai comentar, comenta DIREITO!

! Clean Code Clean Code não é sobre: Linguagem

Sobre o livro Robert C. Martin

Clean code

Mais conteúdo relacionado

Mais procurados (20)

Semelhante a Clean code (20)

Mais de Marcos Brizeno (18)

Último (20)

Clean code