Este documento discute boas práticas para criar códigos limpos e de alta qualidade, focando em tópicos como nomes significativos, funções pequenas que fazem uma coisa só, comentários úteis, formatação consistente e tratamento de erros usando exceções. O objetivo é produzir códigos eficientes, de fácil manutenção e entendimento.

1. Boas Práticas
Clean Code
Técnica para um código limpo
Rodrigo Kono
MVP, MCTS, MCPD, MCT, MCP
@rodrigokono
www.rodrigokono.net

2. Há duas razões pelas quais
você está nesta palestra:
1. Você é um programador
2. Deseja se tornar um ainda melhor.

3. ÓTIMO! PRECISAMOS DE
PROGRAMADORES MELHORES
Robert C. Martin

4. The Clean Coder
Robert C. Martin (Uncle Bob); Programador desde 1970;
Fundador e Presidente Object Mentor Inc.
Livros:
Designing Object-Oriented C++ Applications using the Booch Method. 1995.
Agile Software Development: Principles, Patterns and Practices. 2002.
Clean Code: A Handbook of Agile Software Craftsmanship.

5. O que é Clean Code?

6. • Eficiente
• Simples
• Direto ao ponto
• Mínimas dependências
• Sem duplicação
• Fácil manutenção
• Padrões definidos
• Fácil leitura e
entendimento
• Coberto de testes
• Elegante
Síndrome da janela quebrada

8. Que porta representa o seu código?

9. "Qualquer um consegue escrever
código que um computador entende.
Bons programadores escrevem
código que humanos endentem“
Martin Fowler

11. Funcionar é o mínimo que se espera

12. Ah! Mas o cronograma é
apertado.
Não tenho tempo para
frescura!
Meu chefe está me
pressionando!
Quero mostrar produtividade.

13. Filho feio não tem pai!

14. Afinal, de quem é a culpa?

15. É nossa!

16. Como mensurar a
qualidade de um código?

17. OK! Vamos ao que interessa

18. NOMES SIGNIFICATIVOS

19. Nomes significativos
int d; // tempo transcorrido em dias
int tempoTranscorridoEmDias;
int diasDesdeCriacaoDoArquivo;
int diasDesdeModificacaoDoArquivo;
int idadeDoArquivoEmDias;

20. Use nomes que revelem a intenção

21. Nomes significativos
public List<int> obter()
{
int[] x = new int[3];
List<int> lista1 = new List<int>();
for (int i = 0; i < lista; i++)
{
if (x[0] == 4)
{
lista1.Add(x[0]);
}
}
return lista1;
}
public List<int> obtemDiasMarcados()
{
int[] diaMarcado = new int[3];
List<int> diasMarcados = new List<int>();
for (int dia = 0; dia < mes; dia++)
{
if (diaMarcado[STATUS] == MARCADO)
{
diasMarcados.Add(diaMarcado[STATUS]);
}
}
return diasMarcados;
}

22. Nomes significativos
public List<int> obtemDiasMarcados()
{
int[] diaMarcado = new int[3];
List<Dia> diasMarcados = new List<Dia>();
foreach (Dia dia in mes)
{
if (dia.marcado)
{
diasMarcados.Add(dia);
}
}
return diasMarcados;
}

23. Use nomes pronunciáveis

24. Nomes significativos
class DtaRcrd102
{
private DateTime gerdmahms;
private DateTime moddmahms;
private string pszqint = "102";
}
class Cliente
{
private DateTime gerarDataHora;
private DateTime modificarDataHora;
private string idRegistro = "102";
}

25. Use nomes buscáveis

26. Nomes significativos
const int DIAS_DE_TRABALHO_POR_SEMANA = 5;
int soma = 0;
int diasReaisDeTrabalho = 4;
for (int j = 0; j < NUMERO_DE_TAREFAS; j++)
{
int tarefasPorDia = trabalhoEstimado[j] * diasReaisDetrabalho;
int taredasPorSemana = (dias / DIAS_DE_TRABALHO_POR_SEMANA);
soma += taredasPorSemana;
}
for (int j = 0; j < 30; j++)
{
s = (t[j]*4)/5;
}

27. Nomeando classes e métodos

28. Nomes significativos
Classes
representadas por substantivos
ex: Cliente, Perfil, Estoque, etc
Métodos
representadas por verbos ou frases verbais
ex: enviarPagamento, salvar, etc.

29. FUNÇÕES

30. Seja pequeno

31. Funções
• Menos é mais!
• Extraia trechos em métodos privados.
• Lembre-se dos nomes significativos
• Vá direto ao ponto.

32. Funções

33. Faça uma coisa só!

34. Funções
• Repare a endentação (sim, é assim que escreve)
• Muitos níveis ~= muita responsabilidade
• O método deve fazer uma única coisa, e bem!
• Está fazendo mais de uma coisa? Extraia.

35. Leia o código de cima pra baixo

36. Funções
• Seu código deve ser lido como uma
narrativa
• Temos sujeitos, verbos e predicados
• Narrativas são frases em ordem
coerente
• Lembre-se disto ao extrair em
métodos privados;

37. Funções
• Muitos argumentos = code smell
• Existem algumas regras para a
quantidade de argumentos
• Argumentos booleanos, em geral, não
são bons.

38. Funções

39. DRY (Don’t Repeat Yourself)

40. COMENTÁRIOS

41. Comentários não ajudam
um código sujo!

42. Comentários
• Em geral, servem para explicar um código ruim.
• Um bom código é auto documentado.
• Extraia para um método que faça o que diz!

43. Comentários aceitáveis

44. Comentários
• Comentários sobre licença (direitos de
uso de uma lib, por exemplo)
• Comentários informativos
• Necessidade de explicação de negócio

45. Comentários ruins

46. Comentários
• Por falta do que escrever
• Redundantes
• Documentação em APIs não públicas
• Dizendo algo que o próprio código
deveria dizer
• Código comentado =S

47. Comentários

48. FORMATAÇÃO

49. O que vale é a regra do time

50. OBJETOS E ESTRUTURA
DE DADOS

51. Abstração de dados

52. Objetos e estrutura de dados

53. Objetos e estrutura de dados

54. A lei de Demeter

55. Objetos e estrutura de dados
Um método M de uma classe C só conhece:
• Métodos de C
• Objetos criados por M
• Objetos passados como argumentos para M
• Objetos em variáveis de instâncias de C

56. Demeter Law
C
M

57. TRATAMENTO DE ERRO

58. Exceções ao invés de
código de erro.

59. Tratamento de erro

60. Tratamento de erro

61. Tratamento de exceção é uma das
coisas que um método ou função faz

62. Não use exceções genéricas

63. Não retorne null

64. Tratamento de erro
• Obriga o uso de if
• Pode disparar NullPointerException
• Considere: Lançar exceção ou retornar um objeto especial

65. Não passe null

66. REGRA DOS ESCOTEIROS
Deixe a área do acampamento
mais limpa do que como você a
Encontrou.

67. Não deixe acumular problemas!

68. Código ruim
cheira mal...
Torna o seu trabalho
lento e desgastante
com o passar do
tempo
Pode arruinar seu
projeto, carreira,
empresa...
Fique atento.

69. Falar é fácil!
O desafio é criar um código de
qualidade.
Portanto, falar é o primeiro passo de melhoria.

70. Using References;
Gustavo Barbosa
http://www.slideshare.net/gustavocsb
Hendrik Ebel
http://www.slideshare.net/hebel
Thiago Faria de Andrade
http://www.slideshare.net/thiagofa

71. END
contato@rodrigokono.net