Atividade para Avaliação - Semana 3

Olá, alunos e alunas!

Esta atividade deve ser preparada em seu computador, em programa apropriado. Salve-o como um arquivo PDF. Para enviá-la para correção, siga os seguintes passos:

1. Clique no botão "Enviar atividade" e, depois, em “Escolher um arquivo”;
2. Na janela que se abrirá, selecione o arquivo em seu dispositivo;
3. Ainda nesta janela, clique em “Abrir”;
4. Ao fim da página, clique em “Enviar atividade”.

Pronto! Sua atividade está postada no AVA.

Atenção: A produção da atividade deverá seguir as normas ABNT.

A revisão pode ser usada para a Garantia da Qualidade, a Verificação e a Validação. Para exemplificar o funcionamento de uma revisão, você participará de uma revisão de um código.

Uma vez que pode ser difícil para você se encontrar fisicamente com os seus colegas, a revisão será feita virtualmente – por texto ou, se viável, por vídeo. Você pode usar o Whatsapp, Skype ou alguma outra ferramenta de comunicação que permita conversa em grupo.

• Analisador
• Carta

Roteiro da inspeção

Papéis

Forme uma equipe com 3 pessoas. Excepcionalmente serão permitidos grupos com 4 pessoas (dado o número de alunos).

O professor e os tutores são o autor. Em caso de dúvidas sobre o código, entre em contato!

Divida os membros da equipe em:

• Líder: será responsável por coordenar a reunião de inspeção.
• Leitor: será responsável por “ler” o código.

Registrador: será responsável por anotar os problemas no relatório de problemas.

• Inspetor (todos): apontarão problemas.

Processo

Preparação

1. Dividir os papéis entre os membros da equipe.
2. Cada um deve ler individualmente o código.
   1. Em caso de dúvidas sobre o código, entre em contato com o professor ou os tutores (o correto seria fazer isso na reunião de inspeção, mas como ela será virtual, teremos que adaptar).
3. Cada um deve ler individualmente a checklist e analisar o código seguindo a checklist.
4. Anotar desvios do código baseados na checklist e em outros problemas.
5. O líder deve agendar a reunião e garantir que todos conseguiram fazer as atividades antes de realizar a reunião.

Reunião de inspeção

No horário agendado:

• O leitor deve resumir um trecho do código, evidenciando as partes principais.
  1. Ou seja, o leitor não deve ler o código. Ele deve explicar o código em alto nível.
  2. Após o leitor resumir o trecho, os membros da equipe devem apontar não conformidades.
  3. Para cada não conformidade apontada, o líder deve coordenar a discussão da classificação e a criticidade.
  4. O registrador deve documentar as não conformidades, apontando:
     1. O item da checklist não atendido
     2. Uma descrição da não conformidade
     3. A classificação (vide abaixo)
     4. A criticidade (vide abaixo)
     5. A linha de código da não conformidade.

• O passo 1 deve ser executado até que todo o código seja lido.
• O líder deve apresentar para a equipe cada um dos problemas identificados e a classificação/criticidade. A equipe deve resolver qualquer problema ou dúvida que apareça.
• Por fim, todos em conjunto devem decidir sobre a aprovação (com ou sem nova revisão) ou a rejeição do código.

 Cuidados

• Não discutir os motivos do problema;
• Não propor soluções/recomendações.

Classificação / Criticidade

Classificação:

• Faltou (ausente)
• Extra (supérfluo)
• Confuso
• Inconsistente
• Fora do padrão
• Incorreto
• Cosmético

Criticidade:

• Grave (G)
• Secundário (S)
• Insignificante (I)

Checklist

Baseada em Wiegers, K. Generic Checklist for Code Reviews. 2001.

Estrutura

1. O código está corretamente indentado?
2. Existe algum método ou código inalcançável?
3. Existe código de teste no código?
4. Existe código repetido que pode ser reorganizado?

Comentários

5. Os comentários são necessários?
6. O código está adequadamente comentado com comentários fáceis de manter?
7. Os comentários são consistentes com o código?

Variáveis

8. O nome das variáveis é significativo, consistente e claro?
9. O tipo da variável é adequado?
10. Existem variáveis redundantes ou não usadas?
11. As variáveis são declaradas no bloco adequado?
12. Existem constantes adequadas ao invés de “números mágicos”?

Laço

13. Todos os laços e condições são completos, corretos e adequadamente aninhados?
14. O laço adequado foi usado?
15. Os casos mais comuns/importantes são testados primeiro na sequência de condições?
16. Todos os casos são tratados pelas condições?
17. As condições de término de laço são claras e sempre atingíveis?

Armazenamento

18. O tamanho das estruturas usadas é adequado?
19. As estruturas de dados usadas são adequadas?

Programação defensiva

20. Os valores dos parâmetros de entrada são adequadamente verificados?
21. Os dados obtidos externamente são verificados?

Código

Classe Analisador (a classe Carta é entregue para que o código compile).

Entrega

Relatório de problemas, contendo para cada não conformidade:

• O item da checklist não atendido
• Uma descrição da não conformidade
• A classificação (vide abaixo)
• A criticidade (vide abaixo)
• A linha de código da não conformidade.

Anotar também se o código foi aprovado ou não. Caso não for, justificar.