Atividade:  Revisar Código

Quando você está criando um software de alta qualidade, a revisão do código-fonte é um complemento de outros mecanismos de qualidade, como a compilação, a integração e o teste. Antes de revisar o código, compile-o e use ferramentas, como os verificadores de regras de código, a fim de capturar o máximo de erros possível. Os erros adicionais também podem ser detectados e eliminados antes da revisão do código, se este for executado usando ferramentas de detecção de erros em tempo de execução.

Os benefícios da revisão de código são os seguintes:

• Impor e estimular um estilo de codificação comum para o projeto. A revisão de código é uma maneira eficaz de os membros obedecerem ao Guia de Programação. Para assegurar isso, é mais importante revisar os resultados de todos os autores e implementadores do que revisar todos os arquivos de código-fonte.
• Localizar erros que os testes automatizados não detectam. As revisões de código capturam erros diferentes daqueles encontrados durante o teste.
• Compartilhar o conhecimento entre as pessoas e transferi-lo das mais experientes para as menos experientes.

Existem várias técnicas que podem ser usadas na revisão de código. Siga um destes procedimentos:

• Inspeção. Uma técnica de avaliação formal em que o código é examinado detalhadamente. As inspeções são consideradas a técnica de revisão mais produtiva. No entanto, essa técnica requer treinamento e preparação.
• Inspeção técnica. Uma técnica de avaliação em que o autor do código conduz um ou mais revisores pelo código. Os revisores fazem perguntas e comentários sobre técnica, estilo, erros possíveis, violação dos padrões de codificação, e assim por diante.
• Leitura de código: Uma ou duas pessoas lêem o código. Quando os revisores estiverem prontos, eles poderão se reunir e apresentar seus comentários e perguntas. No entanto, a reunião pode ser omitida e os revisores podem apresentar seus comentários e perguntas para o autor em um formulário por escrito. A leitura de código é recomendada para verificar pequenas modificações e como uma forma de "verificação de sanidade".

Consulte também Diretrizes: Revisões.

Estabelecer Pontos de Verificação do Código-Fonte

Esta seção fornece alguns pontos de verificação gerais, apenas como exemplos do que deve ser procurado em uma revisão. O Guia de Programação deve ser a principal fonte de informações sobre a qualidade do código.

Geral

• O código obedece ao Guia de Programação?
• A documentação do código é automática? É possível compreender o código por meio da leitura?
• Todos os erros detectados pela verificação das regras de código e/ou pelas ferramentas de detecção de erros em tempo de execução foram abordados?

Comentários

• Os comentários estão atualizados?
• Os comentários são claros e corretos?
• Os comentários são fáceis de serem modificados, caso o código seja alterado?
• Os comentários explicam por quê, e não como?
• Todas as surpresas, casos excepcionais e erros de artifício são comentados?
• A finalidade de cada operação é comentada?
• Os outros fatos relevantes sobre cada operação são comentados?

Código-fonte

• Cada operação tem um nome que descreve o que ela faz?
• Os parâmetros têm nomes descritivos?
• O percurso normal em cada operação é claramente distinguível dos outros percursos excepcionais?
• A operação é muito longa e pode ser simplificada extraindo-se as declarações relacionadas em operações privadas?
• A operação é muito longa e pode ser simplificada reduzindo o número de pontos de decisão? Um ponto de decisão é uma instrução em que o código pode seguir percursos diferentes como, por exemplo, as sentenças if-, else-, and-, while- e case-.
• O aninhamento de loops é minimizado?
• As variáveis estão nomeadas adequadamente?
• O código é simples e evita soluções "complexas"?

Copyright  (c) 1987 - 2001 Rational Software Corporation

Rational Unified Process