Código Limpo Cap. 2"Nomes Significativos" Achiles, Felipe, Guilherme, Wilker
Use nomes que revelem seupropósito- O nome de uma variável, classe ou funçãodeve responder a todas as grandes questões,com...
Evite informações erradas- Deve-se evitar palavras cujos significadospodem se desviar do desejado. Ex: Não sereferencia a ...
Faça distinções significativas- Se os nomes precisam ser diferentes, então tambémdevem ter significados diferentes.- Usar ...
Use nomes pronunciáveis- Use nomes pronunciáveis para facilitar aidentificação e comunicação.- Ex: Uma variável chamada ge...
Use nomes passíveis de busca- Evite nomes de uma letra só.- O tamanho do nome deve ser proporcional aotamanho do escopo.
Evite codificações- Codificações de variáveis são altamente nãorecomendadas- Até mesmo o próprio programador, após certote...
Evite o mapeamento mental-Ocorre quando não se é levado emconsideração os termos domínio do problema enem os da solução-At...
Não dê uma de espertinho- Não use gírias, coloquialismos ou piadas emnomes.- Diga o que você quer expressar. Expresse oque...
Selecione uma palavra por conceito- Escolha uma palavra por cada conceitoabstrato e fique com ela. Por exemplo, éconfuso t...
Não faça trocadilhos- Evitar usar a mesma palavra para doispropósitos.- Por exemplo, se "add" é usado para nomesde métodos...
Use nomes a partir do domínio dasolução- Evite usar nomes que referenciem oproblema, para evitar que toda hora, outrosprog...
Use nomes de domínios doproblema-Deverá ser usada quando não puder seaplicar o uso de domínio da solução paranomes, que fa...
Adicione um conexto significativo- Uma variável analisada sozinha, geralmentenão revela muito sobre o contexto dela- Adici...
Adicione um contexto significativoEssa variáveis juntas te dão a noção deendereço. Mas e se olhasse para a variável"país" ...
Não adicione contextosdesnecessários-Nomes curtos geralmente são melhores desdeque sejam claros-Não adicione mais contexto...
Conclusão-Para se escolher bons nomes, é necessáriopossuir boas habilidades de descrição-Não tenha medo de mudar nomes, de...
Dúvidas???
Próximos SlideShares
Carregando em…5
×

Codigo limpo: Nomes Significativos Cap 2

879 visualizações

Publicada em

0 comentários
0 gostaram
Estatísticas
Notas
  • Seja o primeiro a comentar

  • Seja a primeira pessoa a gostar disto

Sem downloads
Visualizações
Visualizações totais
879
No SlideShare
0
A partir de incorporações
0
Número de incorporações
1
Ações
Compartilhamentos
0
Downloads
10
Comentários
0
Gostaram
0
Incorporações 0
Nenhuma incorporação

Nenhuma nota no slide

Codigo limpo: Nomes Significativos Cap 2

  1. 1. Código Limpo Cap. 2"Nomes Significativos" Achiles, Felipe, Guilherme, Wilker
  2. 2. Use nomes que revelem seupropósito- O nome de uma variável, classe ou funçãodeve responder a todas as grandes questões,como porque existe, o que faz e como é usado.- Se um nome requer um comentário, entãonão revela seu propósito.Ex: imprimeDanfe(); criaUsuario();
  3. 3. Evite informações erradas- Deve-se evitar palavras cujos significadospodem se desviar do desejado. Ex: Não sereferencia a um grupo de contatos comolistaDeContatos a não ser que o grupo de fato,seja uma lista. Se o que armazena o grupo nãofor uma lista, o nome pode confundir os outros.- Não usar nomes muito parecidos.
  4. 4. Faça distinções significativas- Se os nomes precisam ser diferentes, então tambémdevem ter significados diferentes.- Usar números sequenciais em nomes (a1, a2... aN) é ooposto da seleção de nomes expressivos. Não geramconfusão, mas simplesmente não oferecem informaçãoalguma sobre a intenção de seu criador.- Na ausência de convenções específicas, não há comodistinguir moneyAmount de money, customerInfo decustomer ou theMessage de message.- Faça a distinção dos nomes de uma forma que o leitorcompreenda as diferenças.
  5. 5. Use nomes pronunciáveis- Use nomes pronunciáveis para facilitar aidentificação e comunicação.- Ex: Uma variável chamada genymdhms(generation date, year, month, day, hour,minute, second). Como você chamariaverbalmente a variável? Poderia serrenomeada para generationTimestamp.
  6. 6. Use nomes passíveis de busca- Evite nomes de uma letra só.- O tamanho do nome deve ser proporcional aotamanho do escopo.
  7. 7. Evite codificações- Codificações de variáveis são altamente nãorecomendadas- Até mesmo o próprio programador, após certotempo, se esquece do significado do códigodescrito- Ex: gR() << Gera Relatório;soDeusEntende() << Código do Fromhell
  8. 8. Evite o mapeamento mental-Ocorre quando não se é levado emconsideração os termos domínio do problema enem os da solução-Atribuir a variáveis nomes curtos, geralmente1 ou 2 letras, exige que o mapeamento mentalseja enorme, pois terá que se lembrar do quetal variável se trata
  9. 9. Não dê uma de espertinho- Não use gírias, coloquialismos ou piadas emnomes.- Diga o que você quer expressar. Expresse oque você quer dizer.
  10. 10. Selecione uma palavra por conceito- Escolha uma palavra por cada conceitoabstrato e fique com ela. Por exemplo, éconfuso ter pegar, recuperar e obter comométodos equivalentes de classes diferentes.
  11. 11. Não faça trocadilhos- Evitar usar a mesma palavra para doispropósitos.- Por exemplo, se "add" é usado para nomesde métodos em várias classes como criação deum novo valor por meio da adição ouconcatenação de outros dois valores, não érecomendado utilizar "add" para um métodoque adicionará um parâmetro a uma coleção.
  12. 12. Use nomes a partir do domínio dasolução- Evite usar nomes que referenciem oproblema, para evitar que toda hora, outrosprogramadores que forem ler o código, tenhamque checar com o cliente o conceito de talnome-Recomendado usar termos do domínio daInformática, de algoritmos, de padrões, pois osprogramadores estão abituados a isso
  13. 13. Use nomes de domínios doproblema-Deverá ser usada quando não puder seaplicar o uso de domínio da solução paranomes, que facilita para o programador-Neste caso, embora seja ruim, pelo menosquem for fazer a manutenção, poderá recorreraqueles que entendam do domínio doproblema para entender certos contextos-Distinguir conceitos de domínio do problema ede dominio da solução é esperado de um bomprogramador
  14. 14. Adicione um conexto significativo- Uma variável analisada sozinha, geralmentenão revela muito sobre o contexto dela- Adicionar um contexto significativo, seria darpelo menos um pouco da noção do que elapossa serEx: primeironome,segundonome, bairro,cidade, estado, país
  15. 15. Adicione um contexto significativoEssa variáveis juntas te dão a noção deendereço. Mas e se olhasse para a variável"país" sozinha? você teria a mesma noção?Não poderia remeter a nacionalidade dealguém?
  16. 16. Não adicione contextosdesnecessários-Nomes curtos geralmente são melhores desdeque sejam claros-Não adicione mais contexto a um nome doque necessário-Aplicável principalmente a classes-Nas instancias de classe aí sim ter umcontexto a mais seria interessante
  17. 17. Conclusão-Para se escolher bons nomes, é necessáriopossuir boas habilidades de descrição-Não tenha medo de mudar nomes, desde queseja para melhor-Ajude as ferramentas atuais a nos ajudar, atéporque memorizar nomes de classes emétodosde uma solução grande, é para poucos
  18. 18. Dúvidas???

×