Como melhorar a legibilidade do código?

Neste post vou dar algumas dicas de como melhorar a legibilidade do código e também a qualidade dele, já que ajuda muito um código fácil de ser lido.

Reutilize o código

Uma parcela grande de desenvolvedores conhece a sigla D.R.Y (Don’t repeat Yourself), que significa não se repita, o que queremos dizer com essa sigla é o seguinte, não devemos ficar repetindo trechos de código, de maneira desnecessária.

Vamos usar o princípio de reutilização de código, além de deixar menos verboso a base de código, previne ficar duplicando tudo.

Não existe a necessidade de ficar escrevendo e reescrevendo a mesma function por exemplo, podemos facilmente utilizá-la em outros locais, assim economizando código e deixando tudo menos verboso.

Imagina se essa function tenha um bug mais para frente, caso tenhamos ela replicada em múltiplos locais, precisamos fazer a manutenção em todos eles, mas se estivermos reutilizando, vamos apenas fazer a manutenção no local específico e assim todo o resto será resolvido.

Solução genérica para manutenção e reutilização

A reutilização, legibilidade e manutenção tem suas vantagens e desvantagens à medida que vai crescendo um e o outro. 

Quando o D.R.Y começa a ser aplicado em demasia, o código vai se tornando mais complexo e talvez a legibilidade pode diminuir um pouco. 

Então é sempre bom usar tudo de maneira pensada e caso trabalhe com um time, informe se e pergunte para o responsável.

Quando pensamos em soluções, às vezes fazemos algo muito genérico para alguma feature. Podemos pensar um pouco diferente e trabalhar com simples e não genérico.

Devemos pensar na solução de maneira que, não comprometa a manutenção e reutilização do código, em muitos casos fica difícil para quem tem um pouco menos de experiência, então sempre vale a pena conversar com os mais experientes.

Muitas vezes, ao trabalhar em uma empresa, vamos lidar com os times internos e externos, então existe um fluxo grande de saída e entrada de pessoas e o código se não tomar cuidado pode se tornar um monstro, então é bom ter regras bem definidas para a escrita dele.

Talvez deixar uma pessoa externa cuidar da solução de correções genéricas, não seja uma escolha muito ideal, visto que ela não tem a vivência do dia a dia com o código, pode ser alguém que acabou de chegar, devemos deixar os mais veteranos ou pessoas que estão com mais tempo, cuidar dessa parte.

Modules, components e classes, vamos deixar o mais enxuto possível

Quando vamos codar e construir uma feature nova para aplicação, devemos pensar nela com todo o cuidado.

A melhor maneira de lidar com isso é a seguinte: dividir cada coisa em seu devido lugar, ou seja, passar a responsabilidade para cada module, componente ou o que seja, devemos deixar os arquivos pequenos e com responsabilidades bem definidas.

Deixando dessa forma, é mais fácil testar, entender e dar a manutenção.

O Angular, React e Vue, trabalham com o conceito de componentes e isso não é à toa, tudo foi pensado e testado para melhor desenvolvimento da aplicação e do nosso dia a dia como desenvolvedor, então vamos aproveitar disso tudo que nos é disponibilizado.

Automatizar regras e diretrizes

Uma parte muito importante para manutenção, reutilização e leitura do código é a arquitetura do mesmo.

Podemos deixar tudo automatizado pelos plugins de nossas IDEs, com isso evitando códigos com endentamento com espaço e outros com tab, o que na minha opinião não tem melhor ou pior e sim o que o time deixou de acordo.

Podemos deixar essas regras programadas no editorconfig. Adicionando apenas o .editorconfig, as regras declaradas nele serão implementadas.

Codar como estivesse em um time, mesmo que seja sozinho

Quando não trabalhamos ainda em empresa ou freelancer é difícil nos imaginarmos como começar a codar em time.

Muitas vezes, quando estamos começando os nossos pequenos projetos é muito comum a gente declarar variáveis que só nós mesmos entendemos (e depois de dias já não lembramos mais), então vamos evitar deixar elas com nomes que não tem sentido, é melhor deixar ela grande e saber do que se trata do que deixar uma variável X e não entender o que ela é.

Comece pensando em como alguém de fora vai entender o que você escreveu, como se um amigo fosse pegar aquele trecho do código e utilizar mais tarde.

Você pode pedir para alguém dar uma olhada no seu código e pedir para ele responder como está na parte de legibilidade, se você não tem um amigo programador, pode ser cara de pau e perguntar no Twitter e marcar programadores, sempre vai ter alguém disposto a lhe ajudar.

Com isso você irá receber o feedback e mesmo que ele seja negativo (na sua visão), vamos aproveitá-lo e ajustar o que é preciso para assim melhorar sempre.

Conclusão

O dia a dia do programador é lidar com códigos e mais códigos, sejam eles legado ou novos, o que irá nos ajudar bastante é ter uma leitura sólida dele e sem dificuldades. 

Então foque sempre em deixar tudo bonitinho e como o time está pedindo, para que as futuras pessoas que peguem ele, olhem e entendam de primeira.
Espero ter ajudado você com essas dicas e utilize elas no dia a dia, vai facilitar muito sua vida e dos próximos.

Gostou? Quer aprender mais de angular? Então veja aqui nosso Curso de Angular.

Aprenda mais de Angular em nossas postagens ou no Youtube.