Oficina de Código Limpo

Apresentação sobre boas práticas de programação. Parte de um mini-curso realizado na Faculdade Sete de Setembro.

Transcript

1. Oficina de Código Limpo
2. Bruno Cavalcante brunofcavalcante@gmail.com github.com/brunocavalcante @bfcavalcante www.astux.com.br www.alvanista.com
3. Código Limpo?
4. "Any fool can write code that a computer can understand. Good programmers write code that humans can understand." – Martin Fowler
7. Motivação
8. Motivação #1 "Talk is cheap. Show me the code". – Linus Torvalds
9. Motivação #2 Manutenção e Evolução
10. Motivação #3 Visibilidade no Mercado
12. Um Bom Programador
13. 1: Versátil
14. Projetos Open Source por Ano C Java Python PHP Ruby Perl
15. 2: Metódico "First, solve the problem. Then, write the code." – John Johnson
16. 3: Otimista
17. 4: Contribua
18. Clean Code: O Livro
19. Português: R$ 75,00 Saraiva Original: R$ 67,00 Cultura
20. Boas Práticas
21. 1. nomes_significativos
22. Nomes Significativos Ruim: int d; //tempo decorrido em dias Bom: int elapsedTimeInDays; int daysSinceCreation; Ruim: public List<int[]> getThem(); Bom: public List <int[]> getFlaggedCells();
23. Nomes Significativos • Use o padrão da linguagem/framework • Evite Codificações • Exite Prefixos/Sufixos • Crie nomes pronunciáveis
24. Nomes Significativos @updates = Update.order_by_relevance.by_users(all_following).limit(20) # Ruby print max(total_liars, total_nonliars), min(total_liars, total_nonliars) # Python def update_gaming_networks if NetworkGameSyncAttempt.should_update?(current_user) GamingNetwork::PSN.sync(current_user) if current_user.psn GamingNetwork::Live.sync(current_user) if current_user.live GamingNetwork::Steam.sync(current_user) if current_user.steam end end #Ruby
25. 2. funcoes() {}
26. Funções • Não passe de 20 linhas (no geral) • Faça somente uma coisa (em todos os casos) • Não cause efeitos colaterais • Prefira Exceptions a Error Codes
27. Funções $(document).ready(function() { renderContent(getMovieList()); renderSourcesOptions(); renderThemeSwitcher(); }); function loadData(source) { switch (source) { case 'www.omdb.org' : loadDataFromOmdb(); break; case 'www.tmdb.org' : loadDataFromTmdb(); break; } } function getTotalOfMovies() { return $('tbody tr').size(); }
28. 3. // Comentários
29. Comentários “Don’t comment bad code — rewrite it.” — Brian W. Kernighan and P. J. Plaugher
30. Comentários • Explique-se no código • Javadocs (e similares) para APIs
31. Comentários data.readline() #won't need the length of predictions
32. 4. Formatação
33. Formatação • Limite de 120 caracteres por linha • Identação com espaços e seguindo o padrão da linguagem/framework Ruby: 2 espaços Python: 4 espaços Java: 4 espaços
34. Formatação #hoppityhop.py import sys def hoppity_hop(number): if (not(number % 3) and not(number % 5)): print "Hop" elif (not(number % 3)): print "Hoppity" elif (not(number % 5)): print "Hophop" for i in range(1, int(sys.argv[1])): hoppity_hop(i)
35. Happy Coding! <3