Revisão de Código

Segundo Ackerman (1984) a revisão é um processo para eliminar defeitos, normalmente é um processo de inspeção com no mínimo 3 passos: Preparação, Coleta e Reparo. Um membro então lê cada artefato procurando por defeitos. Esses defeitos são coletados e discutidos normalmente em reuniões. Então o autor repara os defeitos encontrados.

Em resumo, uma revisão de código é o processo de avaliar um código novo ou legado procurando por bugs, erros e desvios nos padrões de qualidade estabelecidos pela organização.

Além do benefício óbvio de aumentar a qualidade, mostrar o código para algum outro desenvolvedor antes de colocá-lo em produção ajuda a disseminar conhecimento sobre a base de código dentro da organização.

Qual a Importância da Revisão de Código?

Incentiva o trabalho em equipe
Compartilha e dissemina o conhecimento entre os membros da equipe
Economia e qualidade

O que fazer?

Entenda o que foi feito;
Conheça o objetivo do código;
Um ou mais desenvolvedores devem ler o código fonte com o objetivo de assegurar a sua qualidade e aprender com o processo;
Defina se a revisão será individual ou coletiva;
Simule situações para testar o ajuste do código;
Revise fazendo perguntas coerentes.

Boas Práticas

Registro de revisão e feedback;
Comunicação constante entre os membros da equipe;
Identificação de padrões de desenvolvimento;
Sem interferência de hierarquia;
Tempo e calma para revisar;
Entenda o contexto do código.

Referências Bibliográficas

A. Ackerman, P. Fowler, and R. Ebenau. Software inspections and the industrial production of software. In Proc. of a symposium on Software validation: inspection-testing-verification-alternatives, pages 13–40. Elsevier North-Holland, Inc., 1984.

David B. Bisant and James R. Lyle. A two-person inspection method to improve programming productivity. IEEE Trans. on Software Engineering, 15(10):1294–1304, Oct. 1989.

Tom Gilb and Dorothy Graham. Software Inspection. Addison-Wesley Publishing Co., 1993.