Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Sign up for free
Menu
Search
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Pricing
Search
Sign in
Sign up for free
Clean Code
Search
Gustavo Barbosa
June 20, 2012
Programming
140
0
Share
Embed
Copy iframe code
Copy JS code
Copy link
Start on current slide
Clean Code
Talk given to my colleagues at Quatix.
Gustavo Barbosa
June 20, 2012
Transcript
72 slides
CLEAN CODE escrevendo código limpo
DISCLAIMER
OVERVIEW
SOBRE O QUE FALAREI • nomenclaturas • funções • classes
• formatação • comentários • objetos • estrutura de dados • tratamento de exceções • boundaries • unit testing
SOBRE O QUE NÃO FALAREI • dependency injection • TDD
• refactoring • emergência • concorrência • frameworks de teste • JUnit
fonte: http://www.osnews.com/story/19266/WTFs_m
O QUE É UM CÓDIGO LIMPO? • direto ao ponto
• mínimas dependências • sem duplicação • fácil manutenção • padrões definidos • de fácil leitura/entendimento • coberto de testes • elegante
“NÃO SOU UM EXCELENTE DESENVOLVEDOR. SOU APENAS UM DESENVOLVEDOR MEDIANO
QUE SEGUE À RISCA AS BOAS PRÁTICAS DE UM CÓDIGO LIMPO.” (um dev muito famoso)
NOMES SIGNIFICATIVOS !
NOMES SIGNIFICATIVOS
USEM NOMES QUE REVELEM A INTENÇÃO
NOMES SIGNIFICATIVOS
USEM NOMES PRONUNCIÁVEIS
NOMES SIGNIFICATIVOS
USEM NOMES BUSCÁVEIS
NOMES SIGNIFICATIVOS
TAMBÉM NOMEAMOS CLASSES E MÉTODOS
NOMES SIGNIFICATIVOS CLASSES MÉTODOS em geral, classes devem ser representadas
por substantivos, não verbos. bons exemplos: Cliente, Perfil, Estoque, etc. em geral, métodos devem ser representadas por verbos ou frases verbais bons exemplos: enviarPagamento, removerPagina, salvar, etc. (prefira o infinitivo)
NÃO SEJA PIADISTA :)
FUNÇÕES !
SEJA PEQUENO
•menos é sempre mais! •extraia trechos em métodos privados •lembre-se
dos nomes significativos ;) •vá direto ao ponto FUNÇÕES
FUNÇÕES
FAÇA UMA ÚNICA COISA
•repare a endentação (sim, é assim que escreve ;) •muitos
níveis ~= muita responsabilidade •o método deve fazer uma única coisa, e bem! •dá para extrair? está fazendo mais de uma coisa FUNÇÕES
LEIA O CÓDIGO DE CIMA PARA BAIXO
•seu código deve ser lido como uma narrativa •temos sujeitos,
verbos e predicados :) •narrativas são frases com uma ordem coerente •lembre-se disso ao extrair em métodos privados FUNÇÕES
FUNÇÕES E SEUS ARGUMENTOS
•muitos argumentos ~= code smell •existem algumas regras para qtd
de argumentos •argumentos booleanos em geral não são bons •ex: FUNÇÕES
FUNÇÕES
EVITE OS SIDE EFFECTS
FUNÇÕES
EXCEÇÕES SÃO MELHORES QUE CÓDIGOS DE ERRO
FUNÇÕES
DRY (DON’T REPEAT YOURSELF)
COMENTÁRIOS !
COMENTÁRIOS NÃO AJUDAM UM CÓDIGO SUJO
•em geral, servem para explicar um código ruim •um bom
código é auto-documentado COMENTÁRIOS •extraia para um método que faça o que diz!
COMENTÁRIOS ACEITÁVEIS
•comentários sobre licença •comentários informativos •necessidade de explicação de intenção
(negócio) COMENTÁRIOS
COMENTÁRIOS RUINS
•por falta do que escrever •redundantes •doc em APIs não-públicas
•dizendo algo que o próprio código deveria dizer •código comentado :/ COMENTÁRIOS
COMENTÁRIOS
FORMATAÇÃO !
O QUE VALE É A REGRA DO TIME
MAS EXISTEM ALGUNS PADRÕES DE LINGUAGENS
PYTHON: PEP8
E JAVASCRIPT?
LIMITES HORIZONTAIS
ENDENTAÇÃO, QUEBRA DE LINHAS E TERNÁRIOS
E O IDIOMA?
OBJETOS E ESTRUTRA DE DADOS
ABSTRAÇÃO DE DADOS
None
None
•objetos expõem comportamentos e escondem dados •estruturas de dados expõem
seus dados e não têm comportamentos significativos OBJETOS E ESTRUTURAS DE DADOS
A LEI DE DEMETER
•um método f de uma classe C só conhece: •métodos
de C •objetos criados por f •objetos passados como argumentos para f •objetos em variáveis de instância de C OBJETOS E ESTRUTURAS DE DADOS
None
TRATAMENTO DE ERRO
EXCEÇÕES AO INVÉS DE CÓDIGO DE ERRO ;)
TRATAMENTO DE EXCEÇÃO É UMA DAS COISAS QUE UMA FUNÇÃO/MÉTODO
FAZ
None
NÃO USE EXCEÇÕES GENÉRICAS
VOCÊ TAMBÉM PODE CRIAR EXCEÇÕES!
NÃO RETORNE NULL
None
NÃO PASSE NULL
CLASSES !
BASICAMENTE AS MESMAS DICAS DE FUNÇÕES ;)
PARTIU ALMOÇAR? ! :D
MUITO OBRIGADO @gustavocsb
More Decks by Gustavo Barbosa
See All by Gustavo Barbosa
Arquitetura de Apps em Cenários Offline
barbosa
2
390
Diet View Controllers
barbosa
0
240
CocoaPods: The dependency manager for Objective-C projects
barbosa
0
69
Parse
barbosa
0
140
Introduction to Object
barbosa
0
84
git-flow: a successful branching model
barbosa
4
110
Git: The fast version control system
barbosa
0
260
Other Decks in Programming
See All in Programming
AI Augmentation Techniques with Liberty
ivargrimstad
1
560
高橋メソッドでCVE解説シリーズ 〜CVE-2026-112816〜
hakkadaikon
0
270
AIコーディング時代のKotest ユニットテストから APIレベルの仕様固定化テストへ
ooga04
0
330
Rails初心者がパスキーを実装してみて大変だったこと
ktombow
0
240
クラウドゲーミングのパフォーマンス最適化に挑む / Cloud Gaming Performance Tuning
vivion
0
360
祈るテストから、探索するテストへ 〜Lincheckではじめる並行処理テスト〜
yyh_gl
0
420
Distance field of Julia set
kinakomoti321
0
330
AWS CDKを理解するために公式の定義を深掘って解説してみる / Understanding AWS CDK by Digging into Its Official Definition
akihisaikeda
3
330
React Native에 현대적인 빌드 도구 더하기: Rollipop 구현기
leegeunhyeok
0
190
Debian JP Projectのサーバー構成
uwabami
1
170
Going Full Circle with Virtual Graphs and Relational Databases
michaelsimons
1
110
Goコンパイラを作ってGoをもっと理解する / Build a Go compiler to better understand Go
ikura_hamu
0
140
Featured
See All Featured
Fireside Chat
paigeccino
43
4.1k
Six Lessons from altMBA
skipperchong
29
4.6k
Reality Check: Gamification 10 Years Later
codingconduct
0
2.4k
Improving Core Web Vitals using Speculation Rules API
sergeychernyshev
21
1.7k
JavaScript: Past, Present, and Future - NDC Porto 2020
reverentgeek
52
6.2k
Navigating Team Friction
lara
192
16k
So, you think you're a good person
axbom
PRO
2
2.3k
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
46
3.1k
brightonSEO & MeasureFest 2025 - Winning Strategies for Black Friday CRO & PPC - Christian Goodrich
cargoodrich
3
910
How To Speak Unicorn (iThemes Webinar)
marktimemedia
1
640
Lightning Talk: Beautiful Slides for Beginners
inesmontani
PRO
2
860
What Being in a Rock Band Can Teach Us About Real World SEO
427marketing
0
1.1k