Examine a solução para aprimorar a atividade de desafio de legibilidade de código

  • 4 minutos

O código a seguir é uma solução possível para o desafio da unidade anterior.

/*
   This code reverses a message, counts the number of times 
   a particular character appears, then prints the results
   to the console window.
 */

string originalMessage = "The quick brown fox jumps over the lazy dog.";

char[] message = originalMessage.ToCharArray();
Array.Reverse(message);

int letterCount = 0;

foreach (char letter in message)
{
    if (letter == 'o')
    {
        letterCount++;
    }
}

string newMessage = new String(message);

Console.WriteLine(newMessage);
Console.WriteLine($"'o' appears {letterCount} times.");

Esse código é meramente "uma solução possível". Você pode ter fornecido alguns nomes de variáveis diferentes, bem como espaçamento vertical e recuo de tabulação diferentes. Aqui está uma lista de alterações feitas.

  • O código inclui uma descrição de nível superior do que a listagem de código inteira está tentando realizar em um comentário de várias linhas na parte superior. Você poderia argumentar que esse é um pequeno aprimoramento nos comentários do código original, no entanto, dada a descrição do desafio do código, não havia muito mais contexto disponível.
  • Os comentários individuais foram removidos porque eles não estavam fornecendo nenhuma informação real sobre a finalidade ou a função do código.
  • Várias linhas em branco foram adicionadas para aprimorar a fluência da listagem de código. Mantenha as linhas de código juntas quando parecerem semelhantes ou quando trabalharem entre si para realizar uma tarefa pequena.
  • Feeds de linha e guias foram adicionados para aprimorar a aparência da instrução foreach e da instrução if.
  • Convenções de nomenclatura de variáveis locais foram aplicadas para transmitir melhor a finalidade de cada valor.

Se você identificou os mesmos problemas e os resolveu de maneira semelhante, parabéns! Prossiga para a verificação de conhecimentos na próxima unidade.

Importante

Se você teve dificuldades para concluir o desafio, talvez seja melhor revisar as unidades anteriores antes de continuar.