Código Limpo — Leitura Obrigatória

Quando comecei a programar o primeiro conceito apresentado pelo professor foi o porquê de programar: “Programamos para que o computador entenda o que queremos que ele faça”. Esse conceito ficou entranhado na minha cabeça de uma forma que para mim, o mais importante era fazer e não me preocupar com como fazer.

Se você já programa a algum tempo, já deve ter feito coisas no seu código para economizar tempo e no fundo você sabia que o que estava fazendo era uma gambiarra. Isso é muito comum, você não foi o primeiro e nem será o último. Mas essas gambiarras estavam me incomodando profundamente com o passar dos anos.

Foi então que decidi procurar sobre boas práticas de programação. Entre um artigo e outo, um post e outro, fui notando que programar era mais do que apenas dizer ao computador. Em um desses artigos havia uma sugestão de leitura: Clean Code de Robert Cecil Martin.

A grande surpresa foi ler esse livro e perceber que tudo que eu estava fazendo e usando estava, de certa forma, errado. Logo nos primeiros capítulos fui confrontado com práticas que eu nunca havia sequer pensado, maneiras de se deixar o código mais claro e conciso, tudo de forma clara e direta. O mais interessante de tudo é perceber que por mais que os exemplos no livro usem uma linguagem, boas práticas de programação são quase universais, independente dos seus objetivos com programação, este livro irá te ajudar e muito.

Pensando apresentar um pouco sobre esse livro, decidi então escrever esse texto para apresentar a vocês alguns dos primeiros tópicos do livro. Meu objetivo não é inventar nada novo nesse texto e sim apresentar o livro e encorajá-los a ler e mudar os rumos de seus estudos na área de programação.

O que é um código limpo?

“Um código limpo é simples e direto tão bem legível quanto uma prosa”

Essa frase é de Groody Booch e provocou uma mudança na minha forma de enxergar o que é programar. Na minha opinião o objetivo principal da criação de um código sempre foi a tradução do que eu queria fazer para o que o computador seria capaz de entender e esta frase vai na direção contrária. Me apresentando uma forma artística de se programar.

O autor do livro, discorre dizendo que o nosso objetivo não deve ser programar para que o computador entenda e sim para que outro programador entenda e aqui nós já temos um grande ensinamento.

Nosso código precisa ser legível e entendível a qualquer outro programador. Devemos nos expressar através de nosso código de modo semelhante a um artista que se expressa pelas suas gravuras. Essa necessidade de nos expressar faz de nós, em alguma medida, artistas. Tal qual um artista revisita sua obra buscando sua perfeição devemos fazer o mesmo na busca de um código perfeito.

Nessa busca, o livro nos apresenta alguns conceitos que nos auxiliarão nesta empreitada.

Nomes tem poder

Ao codificar precisamos usar a magia das palavras ao nosso favor. Se você já programou algo relativamente grande deve ter se deparado com uma situação de querer lembrar o que determinada função fazia, o que determinada variável guardava e tudo isso porque você não escolheu um nome apropriado.

Escolha as palavras buscando a melhor maneira de se expressar. Não se preocupe em acertar logo na primeira tentativa, mude os nomes conforme for pensando em nomes melhores. Quando comentei sobre revistar seu código era disso que estava falando. Volte, releia, mude o que for necessário para garantir que sua obra estará a mais clara e simples, possível.

Funções

A primeira ferramenta organizacional que temos contato são as funções. Para que o código permaneça limpo, nossas funções devem ser especialistas ao máximo que pudermos, isso significa que nossa função deve realizar somente uma tarefa.

Isso implica em algumas coisas, se nossa função fará somente uma única rotina, ela será pequena e receberá poucos ou nenhum parâmetro e isso é excelente. Pense que você está contribuindo com um código e você chama uma função exibir que foi implementada por um colega. O que você quer é ver os dados, mas o seu colega a criou pensando em excluir os dados à medida que fossem exibidos. Pronto, você perdeu todos os dados porque o seu colega criou uma função com mais de um objetivo.

O exemplo é um pouco exagerado, mas não muito, só para ilustrar como é importante que nossas funções desempenhem apenas um papel. Além do fator técnico, funções pequenas ajudam na manutenção e leitura do nosso código, melhorando a forma como nos expressamos no código.

Comentários

Comentar nas redes sociais é algo que faz parte do nosso dia a dia — não esqueça de comentar esse texto haha — mas na programação comentar pode não ser tão bom assim. Quem nunca fez um comentário para explicar alguma gambiarra ou algo que não está tão claro?! E aí que está o problema!

“Comentários são sempre fracassos”

Calma, você não é o primeiro e nem será o último a precisar comentar algo para explicar o código. Fazemos comentários numa tentativa de contornar a nossa incapacidade de nos expressar através de nossos códigos. Se nosso código fosse claro, simples, direto e bem escrito como uma prosa, comentários seriam desnecessários.

Esse deve ser nosso objetivo, nos expressar de maneira clara o bastante através de nossos códigos.

Conclusão

Programar bem e criar um código limpo não é algo do dia para noite, é um processo longo. Naturalmente nós adquirimos hábitos que podem não ser os melhores e abandoná-los exige disciplina e muito estudo. Quanto mais praticarmos estas boas práticas mais próximos estaremos de desenvolver um código limpo.

Eu escrevi alguns textos aprofundando os tópicos aqui apresentados: Nomes tem poder, Cada um no seu Quadrado e Comentários.