Código Limpo — Nomes significativos
Não sei você, mas eu só consigo fixar algo se faço anotações. Neste artigo, consolido minhas anotações sobre o capítulo 2 do livro Código Limpo do nosso mestre Robert C. Martin. Espero verdadeiramente que possa ser útil de alguma forma.
No livro, o autor começa seus capítulos sempre com uma imagem ilustrativa que resume o tema abordado. Particularmente, gosto desse tipo de associação visual, porque ajuda a fixar e entender o que virá a seguir. No capítulo 2, a imagem apresentada é a de um casal com seis filhos, onde a mãe grávida do sétimo (ou quem sabe de gêmeos 😅), escolhe o nome a partir de uma revista de sugestão de nomes.
A imagem em si já nos traz uma reflexão por associação. Nomes são tão importantes em nossa vida pessoal, porque não seriam em nossa profissão, afinal, como diz Uncle Bob no livro “damos nomes as coisas o tempo todo em nossos softwares”.
A partir dessa premissa, alguns subcapítulos são apresentados, resolvi traze-los em formato de imagem, mas precisamente em um mapa mental, assim, mesmo sendo algo puramente textual, tem um percentual visual que facilita a fixação:
Mas meu objetivo aqui não é reproduzir o livro em outro formato, aliás seria uma afronta, pois o livro é primoroso em todos os aspectos. Mas você deve estar se perguntando o que "diabos" irei abordar neste artigo então?
Vamos com calma, afinal, para fixarmos um aprendizado, precisamos unir além de nossos sentidos da visão, audição e fala (sim, você deveria ler em voz alta os artigos de seu interesse), devemos exercitá-lo ativamente ao longo do tempo para que o conteúdo seja transferido para nossa memória de longo prazo (um dia escrevo mais sobre isso, mas se quiser adiantar pesquise por Paul Kelley).
Organizei os subtópicos do capítulo em duas partes. A primeira, como um checklist que permite validar nomes já definidos e, a segunda, uma lista de dicas e sugestões de como pensar em nomes mais adequados, segundo as orientações propostas por Uncle Bob.
1. Comece com um Checklist
Cada tópico descreve cenários que podemos transpor para perguntas diretas, facilitando a avaliação em nossos projetos, veja:
2. Dicas e sugestões
O autor apresenta preciosas dicas e sugestões para nomearmos variáveis, constantes, métodos e classes de forma que não seja necessário muito esforço para entendimento do fluxo sistêmico e de negócio de uma determinada solução, nem mesmo por um novo integrante de nosso time.
Conclusão do tipo, faça você mesmo…
Apesar da sintese do capítulo, acredito que não há formulas máginas que substituam o exercício diário. Ainda continuo exercitando ativamente essas orientações no meu dia a dia e um dos maiores desafios são os códigos legados.
Com cuidado, podemos pouco a pouco migrar os nomes confusos de nosso código legado, mas lembre-se de validar os testes unitários e de até solicitar um teste de regressão para o time de testes, garantindo que o fluxo onde as alterações foram feitas continuam funcionando.
Por fim, eu reconheço que não será do dia para noite que vamos fixar cada tópico, acredito que somente o exercício de colocarmos em prática no dia a dia do código, será possível adquirir a familiaridade com as orientações descritas no livro, e com isto, ter mais clareza em nossas nomeações.
Boa sorte em suas nomeações daqui em diante! 🖖