Diretrizes para a condução de revisões de design e código

As diretrizes a seguir fornecem várias técnicas para revisões de design e código.

Necessário

• Gastar seu tempo para conduzir a revisão.

  O objetivo da revisão é compreender e analisar o design e o código cuidadosamente. Gastar até metade do tempo em uma revisão que você fez escrevendo o código ou planejando originalmente a estrutura.

• Permitir que os revisores conduzam a revisão.

  Os revisores e seus comentários devem conduzir a revisão. Se forem permitidos desenvolvedores a liderar revisões de seu próprio trabalho, outros revisores podem sentir problemas.

• Ler o código ou documento de design antes da reunião de revisão.

  A menos que você esteja na reunião para examinar quaisquer alterações muito pequenas, prepare-se com antecedência para as reuniões de revisão. Nas reuniões de revisão, os revisores que não se prepararam antecipadamente lendo o código ou o design desperdiçam tempo de todos os envolvidos.

• Use o Project Team Portal para revisões de grupo.

  Publicar seus documentos de design em um portal de projeto onde todos podem facilmente localizá-los e revisá-los. Envie um ponteiro do documento publicado para seus revisores e peça-lhes para adicionar seus comentários usando o recurso de discussão do Internet Explorer. Se você desejar ter seu código da mesma forma revisado, cole o código em um documento do Word e publique-o em um site do SharePoint também. Para obter mais informações, consulte Planejando e acompanhando projetos.

• Use uma lista de verificação.

  É fácil se deixar levar por determinados aspectos da uma revisão, por exemplo, concentrando-se exclusivamente em segurança, tratamento de erros, ou estilo. Você pode ser tentado a passar para outras tarefas após concluir um único aspecto. As listas de verificação lembrarão você dos muitos aspectos diferentes que você deve cobrir na sua revisão.

• Controle todas as questões encontradas durante as revisões de código.

  Documentar problemas como itens de trabalho, como comentários no código, ou como problemas nos documentos de design. Caso contrário, os problemas podem ser perdidos e você não ter ganho nada pelo o tempo que você investiu na revisão do código. Para obter mais informações, consulte Criar um Item de trabalho.

Evitar

• Alterar o código ou design sem informar aos revisores.

  Você pode achar defeitos em seu código ou design após você enviá-los para revisão, mas você deve resistir a tentação de corrigir os problemas antes da reunião de revisão. Se você alterar o código ou o design antes da reunião, a revisão será confusa e seus revisores provavelmente se sentirão ofendidos. Em vez disso, trate os erros que encontrar como se você fosse o revisor; anote-os e controle-os junto com todos os outros comentários de revisão.

Recomendável

• Incluir representantes de todas as disciplinas.

  Embora não seja sempre viável ter uma variedade de disciplinas diferentes do desenvolvimento para rever os designs e o código, representantes de várias disciplinas podem ajudar a descobrir problemas difíceis de localizar. Uma pessoa, ou talvez duas pessoas por disciplina sejam suficientes. Envolver mais pessoas que isso as revisões se tornam longas e difíceis de gerenciar.

• Examine todos os códigos e designs.

  Para obter qualidade em seu produto, tenha revisões de código e design para todo o trabalho. Revisões devem incluir a análise de código, testes de unidade e documentar o design desde o início.

• Considere a criação de shelvesets para gerenciar o seu código revisa.

  Você pode criar um shelveset que contém somente as alterações que você deseja que os revisores para examinar. Quando você cria um shelveset, compartilhar suas alterações com os revisores sem verificar as alterações controle de versão. Para obter mais informações, consulte Trabalhando com Shelvesets.

Consulte também

Conceitos

Analisar a qualidade do aplicativo usando as ferramentas de análise de código

Aprimorando a qualidade de código com diretivas de Check-in do projeto de equipe