Código Limpo - DevDay Fatec Mogi Mirim 2019

Transcript

1. Código Limpo
2. Roger Albino
3. Roger Albino • Engenheiro de Software e Líder Técnico de JavaScript na Kazap Tecnologia.
4. Roger Albino • Engenheiro de Software e Líder Técnico de JavaScript na Kazap Tecnologia. • React, React Native, NodeJS, Graphql…
5. Roger Albino • Engenheiro de Software e Líder Técnico de JavaScript na Kazap Tecnologia. • React, React Native, NodeJS, Graphql… • Sou músico
6. Roger Albino • Engenheiro de Software e Líder Técnico de JavaScript na Kazap Tecnologia. • React, React Native, NodeJS, Graphql… • Sou músico • Curto uma cerveja .
7. Roger Albino • Engenheiro de Software e Líder Técnico de JavaScript na Kazap Tecnologia. • React, React Native, NodeJS, Graphql… • Sou músico • Curto uma cerveja . • @rogeralbinoi
8. Roger Albino • Engenheiro de Software e Líder Técnico de JavaScript na Kazap Tecnologia. • React, React Native, NodeJS, Graphql… • Sou músico • Curto uma cerveja . • @rogeralbinoi
9. • Temos mais de 11 anos de mercado, hoje estamos no Reino Unido, Portugal e sede em Mogi Guaçu. • Nosso objetivo é facilitar a transformação digital nas organizações. • Desenvolvemos aplicações personalizadas para Web, Dispositivos moveis, interfaces conversacionais (Assistentes pessoais e Chatbots) • Ruby on Rails, JavaScript, Java, Python, machine learning… • www.kazap.com.br
10. Código limpo (clean code)
11. Código limpo (clean code) • Técnicas para escrever código bom
12. Código limpo (clean code) • Técnicas para escrever código bom • Livro por Robert C. Martin (Uncle Bob)
13. Código limpo (clean code) • Técnicas para escrever código bom • Livro por Robert C. Martin (Uncle Bob)
14. Código limpo (clean code) • Técnicas para escrever código bom • Livro por Robert C. Martin (Uncle Bob) • Clean code ou Código limpo
15. Um bom código realmente importa?
16. Um bom código realmente importa? • Somos autores, uma boa comunicação é nossa responsabilidade;
17. Um bom código realmente importa? • Somos autores, uma boa comunicação é nossa responsabilidade; • Outras pessoas vão ler o seu código;
18. Um bom código realmente importa? • Somos autores, uma boa comunicação é nossa responsabilidade; • Outras pessoas vão ler o seu código; • Você também (em um futuro não tão distante);
19. Um bom código realmente importa? • Somos autores, uma boa comunicação é nossa responsabilidade; • Outras pessoas vão ler o seu código; • Você também (em um futuro não tão distante); • Passamos mais tempo dando manutenção em código existente;
20. Um bom código realmente importa? • Somos autores, uma boa comunicação é nossa responsabilidade; • Outras pessoas vão ler o seu código; • Você também (em um futuro não tão distante); • Passamos mais tempo dando manutenção em código existente; • Perdemos horas e recursos importantes devido a um código mal escrito.
23. Um código ruim reduz a produtividade do time com passar do tempo 0 25 50 75 100 Tempo Produtividade
24. Jogar tudo fora e começar de novo
25. Jogar tudo fora e começar de novo • Galera não aguenta mais trabalhar neste código confuso (produtividade lá em baixo);
26. Jogar tudo fora e começar de novo • Galera não aguenta mais trabalhar neste código confuso (produtividade lá em baixo); • Resolvem começar o projeto do zero;
27. Jogar tudo fora e começar de novo • Galera não aguenta mais trabalhar neste código confuso (produtividade lá em baixo); • Resolvem começar o projeto do zero; • Mas o projeto que já existe deve ser mantido;
28. Jogar tudo fora e começar de novo • Galera não aguenta mais trabalhar neste código confuso (produtividade lá em baixo); • Resolvem começar o projeto do zero; • Mas o projeto que já existe deve ser mantido; • Logo essa nova versão também está cheia de código ruim e precisaremos começar tudo do zero de novo;
29. Jogar tudo fora e começar de novo • Galera não aguenta mais trabalhar neste código confuso (produtividade lá em baixo); • Resolvem começar o projeto do zero; • Mas o projeto que já existe deve ser mantido; • Logo essa nova versão também está cheia de código ruim e precisaremos começar tudo do zero de novo;
30. Tá funcionando? Não mexe!
31. Tá funcionando? Não mexe!
32. O que é um código bom?
33. https://www.osnews.com/story/19266/wtfsm/
34. Saber o que é um código bom não te faz escrever um código bom.
35. Nomes
36. Nomes • Nomeamos coisas o tempo todo (variáveis, funções, parâmetros, classes, pacotes);
37. Nomes • Nomeamos coisas o tempo todo (variáveis, funções, parâmetros, classes, pacotes); • Escolha nomes que revelem seu propósito
38. Nomes • Nomeamos coisas o tempo todo (variáveis, funções, parâmetros, classes, pacotes); • Escolha nomes que revelem seu propósito • Escolher bons nomes leva tempo, mas economiza um tempão no futuro.
39. Nomes • Nomeamos coisas o tempo todo (variáveis, funções, parâmetros, classes, pacotes); • Escolha nomes que revelem seu propósito • Escolher bons nomes leva tempo, mas economiza um tempão no futuro. • Quando encontrar nomes melhores, troque-os.
40. Nomes • Nomeamos coisas o tempo todo (variáveis, funções, parâmetros, classes, pacotes); • Escolha nomes que revelem seu propósito • Escolher bons nomes leva tempo, mas economiza um tempão no futuro. • Quando encontrar nomes melhores, troque-os.
41. Nomes • Evite dicas erradas const accountList = { items: [{ _id: 1, name: 'Foo Bar' }], total: 1 }
42. Nomes • Evite dicas erradas function foo (a, O, l) { if (a === O) { return 'é igual O’ } if (l === 1) { return 'é igual a zero' } }
43. Nomes • Evite dicas erradas const productData const productInfo
44. Nomes • Evite dicas erradas • Evite Siglas a menos que todos conheçam (API por exemplo)
45. Nomes • Evite dicas erradas • Evite Siglas a menos que todos conheçam (API por exemplo) • Evite usar apenas uma letra (x, y, z, a, b ,c)
46. Nomes • Evite dicas erradas • Evite Siglas a menos que todos conheçam (API por exemplo) • Evite usar apenas uma letra (x, y, z, a, b ,c) • Evite usar termos que poucas pessoas conheçam
47. Nomes • Evite dicas erradas • Evite Siglas a menos que todos conheçam (API por exemplo) • Evite usar apenas uma letra (x, y, z, a, b ,c) • Evite usar termos que poucas pessoas conheçam • Crie nomes buscáveis
48. Nomes • Evite dicas erradas • Evite Siglas a menos que todos conheçam (API por exemplo) • Evite usar apenas uma letra (x, y, z, a, b ,c) • Evite usar termos que poucas pessoas conheçam • Crie nomes buscáveis • Crie nomes pronunciáveis
49. Nomes de Classes • Substantivo (Ex: Account, Cart, Shipping)
50. Nomes de Métodos • Verbos (Ex: addItem, removeItem, getProductList)
51. Evite usar a mesma palavra para dois propósitos no sistema.
52. Funções
53. Funções • Devem ser pequenas;
54. Funções • Devem ser pequenas; • Ter apenas uma responsabilidade (Fazer apenas uma coisa);
55. Funções • Devem ser pequenas; • Ter apenas uma responsabilidade (Fazer apenas uma coisa); • Blocos de indentação (if, else, while), devem ter apenas uma linha (possivelmente uma chamada de função);
56. Funções • Devem ser pequenas; • Ter apenas uma responsabilidade (Fazer apenas uma coisa); • Blocos de indentação (if, else, while), devem ter apenas uma linha (possivelmente uma chamada de função); • Se você pode extrair uma função do nome dela, faça isso! (Ex: calculaTotalEGeraBoleto)
57. Funções • Devem ser pequenas; • Ter apenas uma responsabilidade (Fazer apenas uma coisa); • Blocos de indentação (if, else, while), devem ter apenas uma linha (possivelmente uma chamada de função); • Se você pode extrair uma função do nome dela, faça isso! (Ex: calculaTotalEGeraBoleto) • Devemos ler o código de cima para baixo
58. Funções
59. Funções • Evitar Switch case (mas se for faze-lo, apenas uma linha por caso, chamando uma função)
60. Funções • Evitar Switch case (mas se for faze-lo, apenas uma linha por caso, chamando uma função) • Não tenha medo de criar nomes grandes (O nome da função deve descrever o que ela faz)
61. Comentários
62. Comentários • Comentários mentem, código não!
63. Comentários • Comentários mentem, código não! • Comente o necessário
64. Comentários • Comentários mentem, código não! • Comente o necessário • Não insira comentários num código ruim, reescreva-o
65. Formatação
66. Formatação • Crie um padrão ou use padrões já conhecidos;
67. Formatação • Crie um padrão ou use padrões já conhecidos; • Indentação, ponto e virgula, aspas duplas ou aspas simples…
68. Formatação • Crie um padrão ou use padrões já conhecidos; • Indentação, ponto e virgula, aspas duplas ou aspas simples… • Use ferramentas que te avisam sobre problemas de formatação (ou que corrijam isso para você, prettier estou olhando para você).
69. DRY (Don’t repeat yourself) (Não repita-se a si mesmo)
70. Regra de escoteiro
71. Regra de escoteiro • Um código bom deve ser mantido
72. Regra de escoteiro • Um código bom deve ser mantido • Devemos previnir código ruim
73. Regra de escoteiro • Um código bom deve ser mantido • Devemos previnir código ruim • "Deixe a área mais limpa do que como você a encontrou”
74. Tem muito mais…
75. Obrigado! @rogeralbinoi