Código limpo

Programação limpa em Java
Módulo 01 - Nomenclatura, Funções e Comentários
Data: 17/07/2012 Formador: Marcio Romualdo da Silva Email: [e-mail]

1

Objetivos


Geral:  No final da sessão o formando será capaz de escrever código Java de forma limpa, clara e de fácil manutenção. Específicos:  No final da sessão o formando será capaz de, na linguagem Java:  Criar variáveis com nomes significativos, sem precisar de comentários.  Criar funções com nomes significativos, sem precisar de comentários.  Escrever funcões pequenas com apenas uma única intenção.  Escrever comentários que ajudam na leitura clara do código.  Identificar os comentários que atrapalham a leitura clara do código.



2

 Código Sujo versus Código Limpo 

3

O que é um código limpo?
 Simples e direto

 Legível (readable)

 Elegante e eficiênte

 Com mínimas dependências para fácil manutenção

 Com nomes significativos

 Sem duplicação

4

Por quê você escreveu código sujo?



Estava tentando ir mais rápido? Estava com pressa? Seu chefe poderia ficar zangado se você tomasse tempo para limpar o código?






Estava cansado de trabalhar no projeto e queria acabar logo?
Havia outras coisas havia prometido terminar e o tempo era curto?

5

O custo total da sujeira

 Assim

que a sujeira aumenta, a produtividade da equipa diminui, aproximando do

zero.

6

Nomes Significativos


Use nomes que revelem a sua intenção!
 Compare:

int d; // elapsed time in days
 Com:

int elapsedTimeInDays;

7

Nomes Significativos


Use nomes que revelem a sua intenção!
 Qual o propósito deste código?

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

Nomes Significativos
 Nós podems melhorar o código consideravelmente:

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