Lista de Verificação: Implementação |  |
Esta lista de verificação contém questões que ajudam a avaliar se a implementação foi criada de forma consistente e completa.
Relacionamentos
Elementos Relacionados | Desenvolvimento Implementação Re-fatoração
Descrição Principal
Os itens nesta lista de verificação representam boas práticas para criar uma implementação de alta qualidade. Tente trabalhar cada item com a maior extensão possível para criar a melhor implementação. Pode não ser possível utilizar todos os itens, e alguns itens podem ser utilizados com abrangência limitada. Nestes casos, tenha certeza que existem boas razões para utilizar um item parcialmente ou não utiliza-lo. Esta lista de verificação não deve ser considerada somente para revisões pesadas de código Cada desenvolvedor deve manter em mente os critérios de qualidade constantes nestes itens de verificação durante a codificação. Quando os desenvolvedores trabalham juntos, a revisão, de acordo com esses critérios, deve ser feita imediatamente de forma que a qualidade esteja assegurada logo assim que eles escrevam o código. A divergência apropriada dos critérios de qualidade descritos aqui pode ser somente um comentário na implementação de forma que os desenvolvedores que examinarem o código no futuro saibam por que a exceção ocorreu.
Itens de Verificação
A implementação está em conformidade com a arquitetura e o design?
A implementação está estruturada da forma que está especificado no design? Todas as funções do design estão implementadas? Todas as interfaces do design estão implementadas de acordo com suas especificações? A implementação adere a todas as restrições arquiteturais e de design?
A implementação é testável?
Você pode testar o comportamento esperado no nível de unidade? O código está escrito de forma que todos os caminhos possam ser exercitados?
A implementação está correta?
A implementação passou em todos os testes de desenvolvedor com sucesso? A implementação suporta os critérios de aceitação dos casos de testes? Todo o código é executável (sem áreas mortas)?
A implementação está entendível?
A implementação expressa claramente a intenção do desenvolvedor? O código está aderente às diretrizes de codificação? Se um conjunto de Diretrizes de codificação não foi identificado, o código deve ser verificado para uma variedade de questões de consistência, tais como convenção de nomes, indentação, espaçamento, etc. Os nomes das variáveis são fáceis de entender? Eles descrevem o propósito da variável? Todos os comentários são necessários para o entendimento do código associado? Os comentários devem melhorar o entendimento do código, ao invés de simplesmente repeti-lo Todos os comentários estão corretos? A implementação corresponde exatamente à documentação?
Não existe nenhuma redundância?
Não existe nenhuma redundância na implementação? (Identifique candidatos para re-fatoração)
Este programa e o material que o acompanha são disponibilizados sob a Eclipse Public License v1.0 que acompanha esta distribuição. Direitos Autorais do OpenUP.