Artigo Clube Delphi 79 - QA Audits - Faça um check-up no seu código-fonte

aBDS 2006

QA Audits - Faça um ckeck-up no seu código-fonte

Auditorias são técnicas que buscam verificar se artefatos de software (como especificações, modelos e código-fonte) estão em conformidade com os padrões definidos e em uso na instituição. Auditorias no código-fonte são as mais conhecidas e, quando aplicadas manualmente, geralmente consistem na seleção aleatória de alguns programas do sistema, objetivando verificar se atendem aos padrões definidos.

A importância em obedecer a esses padrões é que tornam os programas mais fáceis de entender e modificar, melhorando a qualidade interna dos sistemas e proporcionando uma maior produtividade por parte das equipes de desenvolvimento e também de manutenção.

O Delphi 2006 trouxe uma ferramenta chamada QA Audits integrada ao IDE para realizar auditorias de software a partir do código-fonte, sugerindo uma série de padrões de codificação que representam boas técnicas de programação. Essa ferramenta avalia a conformidade do código-fonte com as auditorias selecionadas e, através dos resultados gerados, pode-se verificar se o código está aderente aos padrões de codificação em uso, podendo indicar partes que necessitam ser reestruturadas.

Este artigo apresenta a ferramenta QA Audits através de um estudo de caso, considerando inicialmente um trecho de código contendo algumas violações das auditorias sugeridas pela ferramenta e, em seguida, como o código deveria ser modificado de forma a atender os padrões estabelecidos por essas auditorias.

A ferramenta QA Audits

Para utilizar a ferramenta QA Audits em um projeto existente, deve-se acessar a guia Model View do Project Manager (Figura 1).

Figura 1. Project Manager

Será apresentada uma mensagem perguntando se o usuário deseja configurar o projeto para utilizar suporte à modelagem. Confirmando a pergunta, a ferramenta de auditoria estará disponível através do menu de contexto (Figura 2).

Figura 2. Acesso a auditoria de software suportadas pelo Delphi 2006

Quando se executa a ferramenta, verifica-se um grande número de opções de auditorias para serem escolhidas, agrupadas em diversas categorias. Cada opção de auditoria contém descrições sobre os padrões de codificação que serão verificados, como também atribui um grau de severidade para a violação da auditoria.

As descrições das auditorias suportadas pelo Delphi 2006 estão disponíveis na janela principal da ferramenta QA Audits (Figura 3).

Figura 3. Auditorias suportadas pelo Delphi 2006

No painel inferior dessa janela é mostrada a definição de uma determinada auditoria, bem como, em muitos casos, um exemplo incorreto e outro correto do código-fonte relacionados à auditoria. Essa janela ainda pode ser utilizada para salvar ou carregar auditorias dos projetos, bem como configurar quais auditorias serão aplicadas." [...] continue lendo...