O documento discute princípios de clean code, incluindo: 1) usar nomes significativos para variáveis e funções; 2) escrever poucos e significativos comentários; 3) formatar o código de maneira legível.

1. Clean Code
André Luiz Leoni
Jean Leno Heidemann

2. Sumario
O que é?
Nomes Significativos;
Comentários;
Formatação;
Objetos;
Estruturas de Dados;
Tratamento de Erros;
Refinamento;

4. Clean Code vs Rendimento da Equipe
Replanejar a construção de um
sistema nem sempre é a
melhor opção;
Um código mal desenvolvido
pode no começo ser eficiente,
porém, com o tempo, pode
levar a empresa a
descontinuidade dele.
Definição Software
Soft - Flexível
Ware - Produto manufaturado

5. Clean Code
Código testável
Legível
Métodos bem definidos
Sem duplicidade de código e sobretudo
Você encontra a informação que você
esperava

6. Nomes Significativos
O nome de uma variável ou classe, deve dizer o porque ele existe;
Nomes devem ser bem distintos;
Nomes de funções devem ser pronunciáveis e passíveis de busca;
Nomes de classes devem sempre ser substantivos;
Nomes de funções não podem dizer que a função tem 2 funcionalidades;
Nomes de métodos devem ser descritivos e conter o verbo do que aquele
método irá fazer;
Padronize as palavras escolhidas no sistema;
Use nomes técnicos na sua aplicação;
Adicionar contextos significativos a variáveis.

7. Nomes Significativos Não faça isso.
Faça isso.

8. Nomes Significativos
Evite
Usar nomes errados
casa | caza
Usar nomes parecidos
informacaoProduto | dadosProduto
Usar nomes sequenciais
Nomes de classes deve sempre ser
substantivos
Produto, Item, Carro, Casa
Nomes de funções devem conter
verbo que indica o que o método
deve fazer
cadastrarProduto, pagarFatura,
solicitarOrcamento

9. Exemplos...

10. Funções
Funções devem ser de Responsabilidade única e
não podem inflingir os princípios de Aberto-
Fechado;
Funções não podem indicar duas funcionalidades;
verificarVendaEOrcamento, receberOuPagarFatura
Funções devem ser pequenas;
Máximo 20 linhas
Máximo 100 caracteres por linha
Nível de identação não deve ser maior que 2

11. Comentários
Os melhores comentários são aqueles que não precisam ser feitos
Bons comentários
Quando explica a intenção de uma decisão tomada, não apenas a informação do código
Alerta para futuros desenvolvedores
Não use comentários quando você pode usar variáveis ou métodos

12. Comentários
Não fazer comentários óbvios
Não fazer comentários de fechamento de instruções
Não comente códigos
Futuros desenvolvedores não sabem o motivo de existir e os matém

13. Formatação
Não é regra, mas classes geralmente tem entre 200 e 500 linhas
Classes menores são mais fáceis de entender
Sugere-se que um limite de até 100 ou 120 caracteres em uma linha
Utilize espaço entre operadores, parâmetros e vírgulas

14. Formatação
A leitura de um código deveria ser tão simples
como um usuário lê um jornal.

16. Identação
Fique atento na
identação dos códigos.

17. Objetos - Lei de Demétrio
Um módulo não deve saber as entranhas do objeto que ele manipula.

18. Objetos x Estruturas de Dados
Objetos
Escondem os dados
Expõem os métodos que manipulam os dados
Estruturas de dados
Expõem os dados
Não possuem métodos significativos

19. Tratamento de Erros
Utilizar exceptions em vez de códigos de erro;
Códigos de erro são mais facilmente esquecidos de serem tratados;
A linguagem Java por exemplo, quando adicionado a declaração “throws”
em um método, força que o desenvolvedor trate o erro
Não retorne null em um método e não passe null em parâmetros
Valores null facilmente causam NullExcelptions

20. Refinamento
Não pense que Clean Code é um trabalho fácil, exige muita prática,
conscientização da equipe e um bom tempo de desenvolvimento para que o
código alcance o seu estado da arte.
Refine seus códigos diariamente, e você em alguns meses já verá o resultado,
e lembre-se sempre:
A prática leva a perfeição!

21. Obrigado! :)