Escreva Código para Pessoas Além de Máquinas

Escreva Código para Pessoas Além de
Máquinas
Edlaine Zamora
Thalita Gomes

Sobre nós
Desenvolvedora de Software na ThoughtWorks
Formada em Informática pela Universidade Estadual de
Maringá
Especializada em Desenvolvimento Web pela Universidade
Estadual de Maringá
Experiência de 6 anos de desenvolvimento de software
@EdlaineZamora

Sobre nós
Deva na ThoughtWorks =)
Formada em Sistemas de Informação pela Universidade
Federal dos Vales do Jequitinhonha e Mucuri
Especializada em Gestão de Projetos Ágeis
Experiência de 6 anos de desenvolvimento de software
@ThalitaPinheiro

Por que devemos
escrever um bom
código?

Por que devemos escrever um bom código?
Escreva código para Pessoas além de Máquinas

Equipe
escreve
código ruim
Fica irritante
qualquer
alteração no
código
É solicitado o
replanejamento
do software
Uma nova
equipe é
selecionada
para isso

Teoria da Janela Quebrada

O que é um bom código?

O que é um bom código?
"É elegante, eficiente, simples, possui lógica direta, poucas
dependências, um bom tratamento de erro, abstrações claras, contém
apenas o necessário, possui testes automatizados, pode ser alterado com
facilidade, possui nomes significativos, possuem métodos e objetos que
fazem apenas uma tarefa, não possui nada de óbvio para ser melhorado.
Pode ser lido de forma natural, possui alta expressividade e parece que foi
escrito por alguém que se importa."
Tio Bob (Robert C. Martin)

Ok, mas como
podemos fazer um
código assim?

Como podemos escrever um bom código?
Utilize a Regra do Escoteiro
Deixe a área do acampamento mais limpa do que como você a encontrou!

Escreva Nomes Significativos
Variáveis, funções, parâmetros, classes,
pacotes, arquivos fontes, diretórios, etc.

Escreva nomes com fácil pronúncia
❖ Ex: generation date, year, month, day, hour, minute e second)

Escreva Boas Funções
Escreva funções:
❖ Pequenas
❖ Sem estruturas aninhadas
❖ Que faça apenas uma coisa

Mantenha o menor número de parâmetros possível

Cuidado com "Efeitos Colaterais"

Evite duplicações
❖ A duplicação pode ser a raiz de todo o mal no software

Porém…

Evite Escrever Comentários

Evite Escrever Comentários
"Não insira comentários em um código ruim, reescreva-o"
(Brian W. KErnighan e P.J. Plaugher)

Comentários em Códigos Público
❖ Se o código é público, uma biblioteca por exemplo, escrever um bom Javadoc é
essencial para sua utilização

Faça uma Boa Formatação
❖ A formatação do código é importante
❖ Serve como comunicação
○ Cada linha representa uma expressão ou estrutura
○ Cada grupo de linhas representa um pensamento completo

Faça uma Boa Formatação
E o mais importante...

Faça uma Boa Formatação combinada com a Equipe
❖ Cada desenvolvedor(a) tem suas regras de formatação preferidas
❖ Se for trabalhar em equipe, as regras são delas
○ O software precisa ter uma formatação consistente
○ A última coisa que precisamos é adicionar mais complexidade ao código
programando-o com um monte de estilo diferente

Saiba Diferenciar Estrutura de dados de Objetos
As estruturas de dados expõem seus
dados e não possuem funções significativas
Estrutura de
dados

Saiba Diferenciar Estrutura de dados de Objetos
Os objetos usam abstrações para esconder
seus dados, e expõem as funções que operam
em tais dados
Estrutura de
dados

Faça um Bom Tratamento de Erro
❖ Retornar código de erro é uma violação da separação comando-consulta
○ Ex.: if (deletePage(page) == E_OK) {...}
❖ Além disso, o chamador da função é obrigado a lidar imediatamente com o erro

Faça um Bom Tratamento de Erro
❖ A exceção deve fornecer o contexto suficiente para determinar a fonte e a localização de
um erro
❖ Crie mensagem de erro informativa e a passe juntamente com a exceção
❖ Mencione a operação que falhou e o tipo de falha

Faça Testes Automatizados
❖ Teste deve ser mantido limpo
❖ Os testes devem ser legíveis
❖ E o que torna o teste legível?
○ Clareza
○ Simplicidade
○ Consistência de expressão

Escreva Código para Pessoas Além de Máquinas

Escreva Código para Pessoas Além de Máquinas

Recomendados

Recomendados

Mais conteúdo relacionado

Semelhante a Escreva Código para Pessoas Além de Máquinas

Semelhante a Escreva Código para Pessoas Além de Máquinas (20)

Escreva Código para Pessoas Além de Máquinas