Clean Code: 7 Princípios para Escrever Códigos Legíveis e Eficientes

Clean Code Fernando Gama
Acadêmico de Sistemas de Informação
Bolsista AIT/CADIS/PROEG

Clean Code – O que é isso?

• Elegante
• Eficiente
• Legível
• Simples
• Direto
• Único
• Bem escrito
• Possui UMA responsabilidade

Clean Code

• Qual sua reação ao ver um código ruim?

Clean Code

• O que todo bom código deve ter?
•
1. Organização;
2. Arrumação;
3. Limpeza;
4. Padronização;
5. Autodisciplina;

Clean Code

• E se...
o código for confuso?

• Lentidão;
• Uma alteração, várias falhas;
• Remendos;
• Queda de produtividade;
• Alocação de mais recursos

Clean Code

1. Nomes significativos
• Nome deve revelar o seu propósito.
• O que fazem? Como são usados? Porque existem?
• Não economize nos caracteres.
• Seja claro.

Exemplo a não ser seguido: (int d;) //tempo em dias;

Clean Code

public List<int[]> getThem(){
List<int[]> list1 = new ArrayList<int[]>();
for(int[] x : theList)
if(x[0] == 4) list1.add(x);
return list1;

public List<int[]> getFlaggedCells(){
List<int[]> flaggedCells = new ArrayList<int[]>();
for(int[] cell:gameBoard)
if(cell[STATUS_VALUE] == FLAGGED)
flaggedCells.add(cell);
return flaggedCells;}

Clean Code

1. Métodos e funções

O que os tornam métodos e funções fáceis de se ler e
entender? A primeira regra dos métodos é que eles devem
ser pequenos, a segunda é que eles devem ser menores
ainda.
• Recomenda-se 20 linhas.
• Deve fazer apenas uma coisa.
• Evite passar muitos parâmetros.

Clean Code

public boolean checkPassword(String username, String password)
{
String passwordStatus =
cryptographer.decrypt(password);
if(passwordStatus.equals(“OK”)) {
Session.initialize();
return true;
}
return false;
}

Clean Code

3. Comentários

• O melhor comentário é aquele que não precisa ser escrito.
• Pode causar confusões.
• Se você pensar em adicionar um comentário é melhor
refatorar.
• Pode ser utilizado para informar ao leitor sobre alguma
consequência
• Não é apropriado inserir no código créditos e autoria,
redundância,informações excessivas, comentários que
devem ser explicados,etc.

Clean Code

4. Formatação

• Importante pois facilita o entendimento.
• Classes de no máximo 500 linhas é uma boa prática.
• Espaços entre operadores, parâmetros e vírgulas.
• Conceitos relacionados próximos um do outro.
• Identação para visualização do escopo.

Clean Code

5. Tratamento de exceção

• Evitar retornar um código de erro.
• Lançamento de excessões.
• Não retornar NULL.
• NULL não pode ser passado como parâmetro.
• As mensagens devem ser informativas.
• Regras de negócio são tratadas em um lugar diferente das
regras de erros.

Clean Code

6. Testes

• Garantir que cada pedaço do código esta funcionando.
• Regras do TDD:
• Você não pode escrever o código até que você tenha criado
um teste que falhe.
• Você não pode escrever mais testes do que seja suficiente
para falhar.
• Você não pode escrever mais código do que o suficiente
para passar o teste que está falhando.

Clean Code

7. Diminuir o número de classes e
métodos

• Objetivo é manter o sistema pequeno

Clean Code

• E muito +:

http://blog.bluesoft.com.br/bluesoft-labs-
clean-code-por-bruno-lui/

http://www.slideshare.net/WillCaputo/clea
n-code-13391715

Clean Code: 7 Princípios para Escrever Códigos Legíveis e Eficientes

Recommandé

Recommandé

Contenu connexe

Similaire à Clean Code: 7 Princípios para Escrever Códigos Legíveis e Eficientes

Similaire à Clean Code: 7 Princípios para Escrever Códigos Legíveis e Eficientes (20)

Plus de COTIC-PROEG (UFPA)

Plus de COTIC-PROEG (UFPA) (20)

Clean Code: 7 Princípios para Escrever Códigos Legíveis e Eficientes