por que a qualidade de código é tão importante para os desenvolvedores?

a qualidade do código pode traduzir-se em quão útil e sustentável é o seu código: o código de alta qualidade pode ser reutilizado e re-desenvolvido; o código de baixa qualidade não dura.Os projetos são muitas vezes uma corrida contra o relógio e o orçamento tão apertado que contar com mais algumas mãos para escrever código é uma quimera. Os cantos de corte podem parecer a saída fácil, mas não vai pagar a longo prazo.

código bem estruturado, seguindo as regras da linguagem, é muito mais fácil de ler e entender por diferentes navegadores e outros desenvolvedores. Também é mais confiável e evita retrabalhos futuros.

os projetos de Software podem estar sujeitos a diferentes restrições em diferentes fases (desde requisitos à análise, desenvolvimento, teste, implantação e manutenção), o que pode, por vezes, levar o código em si a ser tratado como o aspecto menos importante (função Sobre forma). No entanto, uma das propriedades mais importantes — e muitas vezes esquecidas — de um bom software é a sua qualidade de código.

a qualidade do código pode ser medida de várias maneiras, mas alguns dos aspectos mais importantes são::

• legibilidade, consistência – como é fácil ler e entender seções do Código; isso inclui clareza, simplicidade e documentação do Código.
• previsibilidade, confiabilidade e robustez — o comportamento do software deve ser previsível, e não propenso a bugs escondidos.
• a manutenção e a fixação, actualização e melhoria da extensibilidade do software devem ser o mais simples possível, não intrinsecamente complexas.Por que a qualidade do código realmente importa?

  dadas as restrições habituais já presentes no desenvolvimento de software, por que o esforço para produzir código de qualidade deve ser tão importante?

  Escrever código de qualidade não deve ser considerado como uma tarefa demorada, mas sim como um dos principais objetivos ao desenvolvimento de software; ela deve ser considerada como um investimento essencial em que o retorno seguirá, quase imediatamente:

  • Código que é altamente legível, consistente e documentada é mais fácil de revisão, levando a um menor esforço de desenvolvimento.
  • código limpo e elegante também é muito mais fácil de entender, manter e estender.
  • Software que é bem projetado e atinge uma menor complexidade de código também beneficia muito em termos de testabilidade e robustez (menos propenso a novos bugs sendo introduzidos).

  em essência, uma alta qualidade de código é uma das formas mais eficazes de reduzir a dívida técnica.

  deixe-me mostrar-lhe um exemplo

  o código de má qualidade pode ser normalmente causado por::

  • falta de (ou insuficiente) estilo/padrões de codificação.
  • sem / poor documentation.
  • arquitectura mal concebida (sem separação de responsabilidades, como em MVC).
  • Alta complexidade método

  No exemplo a seguir, o objetivo do método não pode ser claramente identificados, sem cuidadoso exame:

  

  • não Há nenhuma documentação de função, sem linhas de comentário, e não aparente padrão de codificação é seguido (ver, por exemplo, o uso de colchetes e as linhas em branco).
  • a complexidade é relativamente elevada devido ao número de diferentes ações e processos (DB consultas, view/output, e business logic), múltiplos níveis de nidificação.
  • existe uma inconsistência nas formas de executar a saída e a interpolação variável.

  dada a sua baixa qualidade, o código é propenso a erros/bugs (sem mencionar preocupações de segurança), e difícil de testar corretamente.

  além disso, quaisquer mudanças no software provavelmente resultarão em um maior esforço de desenvolvimento e teste e ainda resultarão em possíveis novos bugs sendo introduzidos.

  no lado oposto, seguindo uma norma de codificação e um código de documentação é um aspecto fundamental da qualidade.

  um exemplo Aleatório disso pode ser visto na figura seguinte, uma seção do controlador de FrameworkBundle de Symfony.php:

  

  Além do método/parâmetro documentação, podemos ver claramente que o:

  • O código é simples e auto-explicativo.
  • as diferentes secções lógicas são separadas por linhas vazias.
  • existem poucos níveis de nidificação / indentação, com declarações de retorno precoces.
  • existem considerações de concepção adequadas (separação de responsabilidades por diferentes objectos/classes).
  • devido à elevada qualidade e clareza do código, a classe/método deve ser fácil de testar e manter, com baixo esforço; a probabilidade de ocorrência de erros também deve ser extremamente baixa.

  como se pode alcançar uma elevada qualidade de código?Aqui estão algumas dicas:

  • escolher um padrão de codificação (estilo) adequado para a língua ou estrutura. Para PHP, por exemplo, PSR-2 pode ser considerado como a recomendação padrão atual. Pode ser possível integrar ferramentas de correção de CS com seu ambiente de desenvolvimento (veja php-cs-fixer)
  • consistência em classe, método e nomes de variáveis é outro fator importante de legibilidade.
  • certificar-se de documentar corretamente classes, propriedades, métodos e blocos particulares de código quando necessário, garantindo Comentários são simples, concisos e eficazes.
  • Refactorar e escolher padrões de design corretos é uma boa maneira de promover a reutilização de código e extensibilidade, e para alcançar uma menor complexidade de classe/método.
  • adicionar ferramentas de análise de código ao ambiente IC, a ser executado antes da fusão de novas alterações. Para PHP, phpmd e / ou phpstan são ferramentas que podem avisar de problemas potenciais no código e têm uma série de regras configuráveis diferentes.
  • o teste automatizado é outro obrigatório; não só ajudará a prevenir novos bugs, mas também a garantir que ele cumpre os requisitos e responde corretamente a diferentes entradas.
  • finalmente, alavancando ferramentas como escrutinador-ci e Codacy para testar e exibir uma visão clara da qualidade de um projeto ao longo do tempo, e detalhes importantes sobre o que e onde as questões são.

  conclusão

  independentemente das metodologias de desenvolvimento, línguas, enquadramentos ou ferramentas, impor uma elevada qualidade de código é uma forma de alcançar um desenvolvimento, testes e manutenção mais rápidos e mais fáceis, O que resulta em custos reduzidos de propriedade de software.

  escrito por João Inácio / Desenvolvedor Sênior e líder de equipe em Cleverti

  este artigo foi originalmente publicado no Blog de Cleverti