5 dicas de código limpo para reduzir a complexidade cognitiva

Você provavelmente entende a frustração que surge ao tentar entender o código antigo de outra pessoa — ou mesmo o seu próprio. O tempo longe mexeu com sua memória e agora você está perdendo o fio do código.

Criar código que você e outras pessoas possam realmente entender é fundamental. Reduzir a complexidade cognitiva é fundamental para ajudá-lo a escrever código limpo, seguro, sustentável e confiável que deixe outros desenvolvedores, inclusive você, mais felizes no longo prazo. Veja como você pode adotar uma abordagem disciplinada.

1. Escreva um código pelo qual sua equipe vai adorar você

O desenvolvimento de software é basicamente um esporte de equipe. É fundamental entender como o código que você escreve se encaixará em um projeto geral e será compreendido pelos outros desenvolvedores que precisam ser capazes de lê-lo.

A complexidade ciclomática foi trazida à cena pela primeira vez como uma forma de avaliar a facilidade de teste e manutenção do fluxo de controle de um módulo. Esta fórmula pode ajudar a avaliar quantos testes são necessários com base na contagem do número de ramificações no código. Isso não dará uma boa ideia de quão difícil será para você ou seus colegas de equipe entender e manter o código no futuro.

2. A vida não está a toda velocidade pela frente

O código linear é seu amigo. Se todo o código fosse uma cadeia de comandos, um após o outro — sem loops ou meandros — você não teria problemas em manter tudo em ordem na sua cabeça. Adicionar loops e ramificações ao seu código torna-o cada vez mais difícil de entender e trabalhar.

A complexidade cognitiva do código aumenta gradativamente cada vez que você faz isso. O problema é que os desenvolvedores precisam ser capazes de escrever código que faça loops e ramificações, incluindo código que use instruções if/else, para criar software. O que é fundamental aqui é a atenção plena. Saiba o que você está usando e deixe claro se seu código está fazendo muito ou não. Se for, considere refatorar. Compreender a complexidade cognitiva do seu código pode ajudá-lo a determinar quando e onde você precisa simplificar.

3. O aninhamento pode criar o caos rapidamente

Código aninhado, por exemplo, loops dentro de loops, é difícil de entender. E quanto mais fundo você aninhar o código, mais esforço será necessário para endireitar as coisas em sua cabeça e entender cada parte do código com o qual você está lidando.

Dê uma olhada no seu código e veja quais componentes aninhados estão causando a maior dor de cabeça. Em seguida, encontre uma maneira diferente de escrever o código. Compreender a complexidade cognitiva que cada componente acrescenta ajudará a guiá-lo no caminho certo.

4. Coisas úteis não aumentam a complexidade

Existem muitas construções que tornam o código mais claro e fácil de entender. As instruções switch são uma boa maneira de ajudar a eliminar uma série de instruções if ou if/else aninhadas que tornam o código obscuro e confuso e não aumentam a complexidade cognitiva do código. Instruções Continue ou Break que ajudam você a sair de um loop também podem ajudar a escrever um código mais claro e, mais uma vez, não aumentarão a complexidade. Estes são apenas alguns dos diferentes tipos de construções que podem ajudar a reduzir a complexidade cognitiva.

5. Use as ferramentas certas e escreva um código limpo

Ferramentas como SonarLint, SonarQube e SonarCloud possuem recursos integrados de medição de complexidade cognitiva que podem ajudá-lo a escrever código que é escrito não apenas para funcionar bem, mas também para ser compreendido e desenvolvido. Eles podem ajudá-lo a analisar seu código melhor e mais de perto, para que você possa entender onde está tornando as coisas mais complicadas do que o necessário. Concentre-se em escrever um código que seja fácil de entender e sua equipe e você mesmo no futuro agradecerão!

Os desenvolvedores devem sempre se concentrar em escrever código limpo – código que seja seguro, confiável, legível e de fácil manutenção, evitando grandes enxaquecas a todos que o utilizam em seus projetos de software. Com a mentalidade e as ferramentas certas, você pode garantir que seu código seja uma ajuda e não um obstáculo para a qualidade do seu software.

A postagem 5 dicas de código limpo para reduzir a complexidade cognitiva apareceu pela primeira vez em The New Stack.