4 dicas para melhorar a qualidade do seu código

AT&T, uma compania de telecomunicação americana, enfrentou uma crise em 1990. Eles queriam agilizar as chamadas de longa distância, os levando a lançar um upgrade de software complexo. O projeto falhou, e sua rede de chamadas de longa distância ficou fora por aproximadamente 9 horas.

Os custos estimados do dano deste apagão inclui U$ 60 milhões em cobranças de longa distância, 200.000 reservas de passagens aéreas não realizadas, e 75 milhões de chamadas telefônicas perdidas. Mais tarde, eles descobriram que o upgrade de software continha uma linha de código com bug, levando a uma bola de neve que terminou num problema gigante.

Apenas uma linha de código mal-escrita pode levar uma empresa ao nocaute, significando que seus projetos também podem terminar por causa disso. É por esse motivo que uma melhora na qualidade de código é necessária. Aqui vão quatro boas práticas para ajudar.

1. Adote convenções de código

Times de desenvolvimento normalmente criam uma lista de normas conhecidas como "convenções de código" (coding conventions). Elas incluem os estilos recomendados e as práticas para linguagens de programação específicas. Às vezes, os times estabelecem convenções para um projeto em particular e, outras vezes, eles estabelecem para toda a empresa.

Usar uma convenção de código encoraja todo mundo a escrever no mesmo estilo, fazendo com que todo mundo consiga entender seu código. Convenções também te ajudam a encontrar os arquivos e as classes em projetos grandes, permitindo que novos programadores consigam trabalhar mais facilmente. Por exemplo, desenvolvedores Java usam camel case para nomear funções, onde a primeira palavra é toda minúscula e as próximas têm primeira letraa em maiúscula – “employeeLastName.”

Convenções de código podem ditar uma ampla gama de coisas, como:

• convenções de nome
• espaços
• operadores
• declarações
• comentários
• identação
• organização de arquivos
• padrões de aquitetura

2. Use um code linter

Um code linter é uma ferramente que automaticamente verifica se seu código se encaixa no seu projeto ou nas convenções de código da sua empresa. Caso não se encaixe, os linters avisarão sobre esse problema.

Durante o desenvolvimento, esses alertas tendem a ser esquecidos quando desenvolvedores priorizam velocidade à qualidade. Mas esses pequenos erros podem acumular rapidamente em um curto período de tempo, levando a um significante retrabalho para seu time. Para evitar essa carga de trabalho excessiva, linters identificam esses erros rapidamente para que você consiga também resolvê-los rapidamente.

Quais linters devo usar?

O tipo de linter vai depender da linguagem que você programa – Java, C#, Python, etc. Por exemplo, um desenvolvedor Python pode usar Pylint para análise de manutenção da qualidade e código. Outros exemplos de linters incluem JSLint, ESLint, e Checkstyle.

3. Adote integração contínua (CI)

Desenvolvedores fazem merge das suas mudanças para a branch principal várias vezes por dia – esse processo é chamado de "integração contínua" (continuous integration, ou CI). Cada merge inicia uma sequência automática de build e testes de código, que podem levar um tempo para serem executados. Mas, se existe um erro, o código não vai rodar, e um sistema de CI previne de avançar para os próximos passos. O time então recebe um relatório e pode corrigir o erro imediatamente.

É por esse motivo que CI é amplamente utilizado em empresas modernas. Ele permite que o time quebre o processo de desenvolvimento em seções menores, o que garante uma maior atenção aos detalhes. Os desenvolvedores recebem retorno instantâneo para que possam evitar qualquer erro que possa atrasar a faze de entrega.

Uma ferramenta de intrgração contínua é crítica a ponto de permitir maior performance ao time de engenharia. Quando for escolher uma ferramenta de CI para seu time, existem fatores importantes a considerar, como suporte ao VCS, suporte a containers, plugins e integrações. Veja esta página (em inglês) para uma comparação de ferramentas.

4. Deixe comentários úteis

Às vezes, desenvolvedores fazem comentários que não são necessários para entendimento do código. Esse tipo de acúmulo pode resultar em tempo extra para desenvolvedores lerem o código. Do oturo lado, existem aqueles que fazem comentários de menos, o que reduz a qualidade do código porque faz com que os desenvolvedores precisem adivinhar o que estão lendo.

Seu objetivo deve ser o caminho do meio. Adicionar comentários apenas quando sentir que são necessários e podem proporcionar valor à sua biblioteca de códigos. As seguintes diretrizes (em inglês) podem ajudar você a escrever comentários significativos

• Escreva comentários para funções complexas. Adicionar comentários à funções que possuem lógica complexa, como as que tem 100 linhas de código. Esses comentários são basicamente atalhos que explicam o que a função deve fazer, assim eles poupam tempo dos programadores tentando adivinhar.
• Escreva um breve comentário no topo de cada arquivo. Esse tipo de comentário não deve exceder três linhas, e devem provicendiar um quadro conciso do objetivo e escopo do seu código. Se seus colegas derem uma olhada no seu arquivo, eles vão conseguir entender o que é em menos de 30 segundos.
• Escreva comentários em cima de cada classe. Esse comentário explicará o propósito e escopo da classe no arquivo. Por exemplo, se a classe é nomeada "LocationService", você pode adicionar um comentário como o seguinte na sua aplicação Javascript:

/* A classe abaixo vai ajudar a encontrar o registro de uma localização com um identificador único. Ele retorna uma localização */
public class LocationService {
 o resto do código vai aqui
}

Traduzido de: 4 tips to improve code quality