Clean code

CLEAN CODE
escrevendo código limpo

SOBRE O QUE FALAREI

• nomenclaturas • objetos

• funções • estrutura de dados

• classes • tratamento de exceções

• formatação • boundaries

• comentários • unit testing

SOBRE O QUE NÃO FALAREI

• dependency injection • emergência

• TDD • concorrência

• refactoring • frameworks de teste

fonte: http://www.osnews.com/story/19266/WTFs_m

O QUE É UM CÓDIGO LIMPO?

• direto ao ponto • padrões deﬁnidos

• mínimas dependências • de fácil leitura/entendimento

• sem duplicação • coberto de testes

• fácil manutenção • elegante sindrome da janela
quebrada

“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

Se o nome requer um
comentário, é um nome
ruim

USEM NOMES QUE REVELEM A INTENÇÃO


1. What kinds of things
are in theList?

2. What is the signiﬁcance
of the zeroth subscript
of an item in theList?

3. What is the signiﬁcance
of the value 4?

4. How would I use the list
being returned?


1. Parte do nosso cérebro é dedicado ao conceito de palavras. e palavras, por deﬁnição,
são pronunciaveis; usemos essa parte do cérebro!

2. Programar é uma atividade social.

3. método Dê tê á Érre Cê Dê


1. Muito mais facil encontrar WORK_DAYS_PER_WEEK DO QUE “5”
2. “SUM” não é de fato um nome muito útil, mas ao menos já é mais buscável do que
simplestemente “s”

3. CODE SMELL! MAGIC NUMBER!

TAMBÉM NOMEAMOS CLASSES E MÉTODOS


CLASSES

em geral, classes devem ser representadas por substantivos, não verbos.
bons exemplos: Cliente, Perfil, Estoque, etc.

MÉTODOS

em geral, métodos devem ser representadas por verbos ou frases verbais
bons exemplos: enviarPagamento, removerPagina, salvar, etc. (prefira o infinitivo)

FUNÇÕES

• menos é sempre mais!

• extraia trechos em métodos privados

• lembre-se dos nomes signiﬁcativos ;)

• vá direto ao ponto

FAÇA UMA ÚNICA COISA

blocos e endentação,
indicios de que está
fazendo muita coisa

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!

• dá para extrair? está fazendo mais de uma coisa

LEIA O CÓDIGO DE CIMA PARA BAIXO

Como uma narrativa

FUNÇÕES

• 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

• muitos argumentos ~= code smell

• existem algumas regras para qtd de argumentos

• argumentos booleanos em geral não são bons

• ex:

FUNÇÕES Onde está o side effect?

EXCEÇÕES SÃO MELHORES QUE CÓDIGOS DE ERRO

COMENTÁRIOS
devem valer os bytes que
consomem

COMENTÁRIOS NÃO AJUDAM UM CÓDIGO SUJO

COMENTÁRIOS “Ooh, I’d better comment that!”
No! You’d better clean it!

• 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!

COMENTÁRIOS
// format matched kk:mm:ss EEE, MMM dd, yyyy

Pattern timeMatcher = Pattern.compile(

"d*:d*:d* w*, w* d*, d*");

• comentários sobre licença

• comentários informativos

• necessidade de explicação de intenção (negócio)

COMENTÁRIOS
// format matched kk:mm:ss EEE, MMM dd, yyyy

Pattern timeMatcher = Pattern.compile(

"d*:d*:d* w*, w* d*, d*");

• 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 :/

FORMATAÇÃO
pode ser interpretado
como uma coisa pessoal.
apesar disso, valem os
padroes entre times

MAS EXISTEM ALGUNS PADRÕES DE LINGUAGENS

PYTHON: PEP8

explicar o pq da PEP 8, é sempre bom saber qual existem padroes para
sua importância para o padrão da linguagem. nomes de classe, nomes
pessoas que vão ler o python tem um padrão, de modulo, nomes de
codigo, etc. Java tem outro, C++ tem metodos, variaveis,
outro constantes, etc.

LIMITES HORIZONTAIS

explicar o pq da linha de
limite horizontal.

ENDENTAÇÃO, QUEBRA DE LINHAS E TERNÁRIOS

E O IDIOMA?

leve em consideracao a
linguagem de dominio. por
exemplo, ficaria
estranho traduizer
“Folião”

OBJETOS E ESTRUTRA DE
DADOS

OBJETOS E ESTRUTURAS DE DADOS

• objetos expõem comportamentos e escondem
dados

• estruturas
de dados expõem seus dados e não têm
comportamentos signiﬁcativos

OBJETOS E ESTRUTURAS DE DADOS

• 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

EXCEÇÕES AO INVÉS DE CÓDIGO DE ERRO ;)

TRATAMENTO DE EXCEÇÃO É UMA DAS COISAS QUE UMA
FUNÇÃO/MÉTODO FAZ

try except finally deve
ser o unico bloco de um
metodo

NÃO USE EXCEÇÕES GENÉRICAS

conheça seu código. saiba
que tipos de exceções
podem ser disparadas. se
nao conhece as exceções
default, dê uma lida nelas

VOCÊ TAMBÉM PODE CRIAR EXCEÇÕES!

se couber fazer uma
exceção especifica, crie
uma classe de Excecao
sua que será usada em
outros pontos do projeto

NÃO RETORNE NULL

- obriga usos de if
- pode disparar
nullpointer
- considere lancar uma
exceção ou retornar um
objeto especial

NÃO PASSE NULL

- obriga tratamento de nulo
- tira a legibilidade do código

algumas linguagens até facilitam

BASICAMENTE AS MESMAS DICAS DE FUNÇÕES ;)

MUITO OBRIGADO

@gustavocsb

Clean code

Mais conteúdo relacionado

Mais procurados

Semelhante a Clean code

Clean code

Notas do Editor